For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
This page is for version 2023-04-25.
For other versions, use one of these documentation indexes:
- 2025-09-18 (default): https://apidocs.polytomic.com/2025-09-18/llms.txt
- 2024-02-08: https://apidocs.polytomic.com/2024-02-08/llms.txt
- 2023-04-25: https://apidocs.polytomic.com/2023-04-25/llms.txt
- 2022-12-12: https://apidocs.polytomic.com/2022-12-12/llms.txt
- 2021-05-23: https://apidocs.polytomic.com/2021-05-23/llms.txt
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
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.
