For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETGet Events
      • GETGet Event Types
Logo
Log inBook a demo
API ReferenceEvents

Get Events

GET
https://app.polytomic.com/api/events
GET
/api/events
$curl https://app.polytomic.com/api/events \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "created_at": "2024-01-01T00:00:00Z",
5      "event": {
6        "execution_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7        "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
8        "sync_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
9        "sync_name": "string",
10        "target_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
11      },
12      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
13      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
14      "type": "sync.running"
15    }
16  ]
17}
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`](../../api-reference/events/get-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.
Was this page helpful?
Previous

Get Event Types

Next

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 null

Errors

422
Unprocessable Entity Error
500
Internal Server Error