Skip to main content
GET
ListCompanyEventImpacts

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

company_id
string[]

Account-scoped logical company IDs to include; storage identifiers are not accepted.

Pattern: ^cm_company_[0-9A-HJKMNP-TV-Z]{26}$
direction
string[]

Accepted values are positive, negative, and mixed.

Accepted values are positive, negative, and mixed.

Pattern: ^(?:positive|negative|mixed|MATERIAL_IMPACT_DIRECTION_(?:POSITIVE|NEGATIVE|MIXED))$
lifecycle
string[]

Accepted values are admitted, corrected, and retracted.

Accepted values are admitted, corrected, and retracted.

Pattern: ^(?:admitted|corrected|retracted|MATERIAL_IMPACT_LIFECYCLE_(?:ADMITTED|CORRECTED|RETRACTED))$
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

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}$
snapshot
object

SnapshotBoundary closes initialization gaps before latest-state polling begins.