Skip to main content
GET
ListMonitoredCompanies

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

lifecycle
string[]

Accepted values are active, paused, and removed.

Accepted values are active, paused, and removed.

Pattern: ^(?:active|paused|removed|MONITORED_COMPANY_LIFECYCLE_(?:ACTIVE|PAUSED|REMOVED))$
coverage
string[]

Accepted values are awaiting_first_scan, adequate, partial, stale, unavailable, and needs_confirmation.

Accepted values are awaiting_first_scan, adequate, partial, stale, unavailable, and needs_confirmation.

Pattern: ^(?:awaiting_first_scan|adequate|partial|stale|unavailable|needs_confirmation|COMPANY_COVERAGE_STATE_(?:AWAITING_FIRST_SCAN|ADEQUATE|PARTIAL|STALE|UNAVAILABLE|NEEDS_CONFIRMATION))$
page_size
integer<int32>

Maximum rows to return, from 1 through 100; zero requests the server default.

cursor
string

Signed opaque cursor bound to the account, filters, mode, expiry, and snapshot generation; never a storage identifier.

Pattern: ^cmc1\.[A-Za-z0-9_-]{16,1000}[A-Za-z0-9_-]{0,536}\.[A-Za-z0-9_-]{43}$
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

companies
object[]
Maximum array length: 100
nextCursor
string
Pattern: ^cmc1\.[A-Za-z0-9_-]{16,1000}[A-Za-z0-9_-]{0,536}\.[A-Za-z0-9_-]{43}$
snapshot
object

SnapshotBoundary closes initialization gaps before latest-state polling begins.