Skip to navigation
API ReferenceEvents

Get Events

Lists audit events for the caller’s organization.

Results are ordered by created_at descending. Use limit to control how many events are returned. The response does not include a pagination token.

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

Use starting_after and ending_before to restrict results to events created strictly after or before a timestamp. Results remain newest first when you use either filter.

ℹī¸ Events reflect audit activity scoped to your Organization. The log captures both user-initiated and API-initiated actions.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Headers

X-Polytomic-VersionstringRequired

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

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error