Skip to main content

Authentication

API key or session token with the events:read permission. API keys have it. An API key lists only the events of its own environment. A session lists production events unless it passes environment=sandbox.

Query parameters

string
Filter by status: pending, completed or failed.
string
Filter by event type, exactly as sent (for example cardiac_arrest).
string
Filter by the code of a category of your catalog, for example pre. See GET /v1/catalog.
string
Filter by vertical, for example healthcare.
string
Filter by zone code, for example zone_lisbon_central.
boolean
true returns only events whose type sends a team (requires_teams) and that have no active mission: no mission, or missions that all ended FAILED. This is the dispatch queue of the optional teams and dispatch module. Any other value is ignored.
boolean
true returns open events sent before 8 October 2026 with a type that is not in your catalog. They were delivered but never dispatched; close them or leave them to their own flow.
integer
default:"50"
Events per page, from 1 to 200. Values above 200 are capped at 200.
string
The next_cursor of the previous page. Omit it for the first page.
string
Sessions only: production (default) or sandbox. Ignored for API keys, which always read their own environment.

Example

To read the dispatch queue:

Response

200 OK
object[]
Events on this page, newest first.
string | null
Pass it as cursor to get the next page. null on the last page.
integer
Number of events that match your filters, across all pages.
The list does not include the payload or metadata. Use GET /v1/events/:event_id for a single event.

Paging through all results

Errors