API reference

Carrier events

Read the event log for the carrier — call, message, and system events — for audit and monitoring.

Event resource

Eventjson

{
  "data": {
    "id": "EV…",
    "type": "event",
    "attributes": {
      "account_id": "AC…",
      "type": "phone_call.completed",
      "created_at": "…"
    }
  }
}

List events

GET/carrier/v1/events

Return events across the carrier.

Parameter	Type	Description
`filter[account_id]` optional	`string`	Restrict to an account.
`filter[type]` optional	`string`	Filter by event type.
`page` optional	`integer`	0-indexed page.
`per_page` optional	`integer`	Records per page.

Fetch an event

GET/carrier/v1/events/{id}

Return a single event.