Skip to main content
GET
GetCompanyMonitoringStatus

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

jmespath
string

Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath.

Response

Successful response

accessState
enum<string>

CompanyMonitoringAccessState describes account access without enabling a product surface.

Available options:
COMPANY_MONITORING_ACCESS_STATE_UNSPECIFIED,
COMPANY_MONITORING_ACCESS_STATE_DISABLED,
COMPANY_MONITORING_ACCESS_STATE_ENTITLED,
COMPANY_MONITORING_ACCESS_STATE_ENTITLEMENT_LAPSED,
COMPANY_MONITORING_ACCESS_STATE_DENIED
companyCount
integer<int32>
Required range: 0 <= x <= 500
companyLimit
integer<int32>
snapshotGeneration
string<int64>
featureFlags
object

CompanyMonitoringFeatureFlags exposes independent rollout state without an aggregate switch.