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.

get/api/events

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

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
typestring

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
ending_beforestring date-time

Return events created strictly before this timestamp.

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

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": "0ecd09c1-b901-4d27-9053-f0367c427254",
        "organization_id": "be80a27e-0e80-4dcb-bee9-1666f02eeb83",
        "sync_id": "0b155265-c537-44c9-9359-a3ceb468a4da",
        "sync_name": "Salesforce contacts",
        "target_connection_id": "7c67e0b3-9759-44eb-b96c-2a7042b583f0"
      },
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "type": "sync.running"
    }
  ]
}

Changes

    • breaking

      added to the /// response property oneOf list for the response status

    • info

      added the optional property ///// to the response with the status