Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Events

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.

get/api/events

Query parameters

organization_idstring uuid nullable

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

Example:248df4b7-aa70-47b8-a036-33ac447e668d

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

typestring

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

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

starting_afterstring date-time

Return events created strictly after this timestamp.

Example:2020-01-01T00:00:00Z

Return events created strictly after this timestamp.

ending_beforestring date-time

Return events created strictly before this timestamp.

Example:2020-01-01T00:00:00Z

Return events created strictly before this timestamp.

limitinteger

Maximum number of events to return. Default 10, maximum 100.

Maximum number of events to return. Default 10, maximum 100.

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "created_at": "2024-01-01T00:00:00Z",
      "event": {
        "execution_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "target_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
      },
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "type": "sync.running"
    }
  ]
}