Skip to navigation
API ReferenceEvents

Get Events

Lists audit events for the caller’s organization.

Results are paginated. If more events are available, the response includes pagination.next_page_token; pass that token back unchanged to continue from the last item you received.

Filter by event type using the event_type query parameter. Pass one of the identifiers returned by GET /api/events_types to narrow results to a specific category of activity.

📘 Events reflect audit activity scoped to the caller’s organization. The log captures both user-initiated and API-initiated actions.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Headers

X-Polytomic-VersionstringOptional

Query parameters

organization_idstringOptionalformat: "uuid"

Organization to list events for. Only used by system callers; normal and partner callers are always scoped to their own organization.

typestringOptional

Filter to a single event type. Use GET /api/events_types to list valid values.

starting_afterdatetimeOptional
Return events created strictly after this timestamp.
ending_beforedatetimeOptional
Return events created strictly before this timestamp.
limitintegerOptional1-100Defaults to 10
Maximum number of events to return. Default 10, maximum 100.

Response

OK
datalist of objects or nullOptional

Errors

422
Unprocessable Entity Error
500
Internal Server Error