Skip to main content
GET
ListCompanyEventChanges

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

cursor
string
required

Required signed opaque poll cursor bound to the account, 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}$
page_size
integer<int32>

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

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

impacts
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}$
pollState
enum<string>

CompanyEventPollState tells a client whether it may continue or must resnapshot.

Available options:
COMPANY_EVENT_POLL_STATE_UNSPECIFIED,
COMPANY_EVENT_POLL_STATE_CURRENT,
COMPANY_EVENT_POLL_STATE_SNAPSHOT_REQUIRED