API ReferenceEvents and Webhooks

List all events

Returns a list of events sorted by creation date, with the most recently created event appearing first. The event list includes data from up to the last 30 days.

Each event’s data is rendered according to the API version at the time of its creation, as specified by the api_version attribute in the event object, rather than the current API version.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Query parameters

created_afterdatetimeOptional

Filter events created after this date (limited to the last 30 days)

order_directionenumOptional

Order direction of the events list asc or desc (default: desc)

Allowed values:
versionenumOptional

API version of the events to return v1 or v2 (default: based on registered webhook endpoint versions)

Allowed values:
pageintegerOptional
The page of results to return. Defaults to 1 if not provided.
page_sizeintegerOptional
The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

Response

OK
itemslist of objects
A paginated array containing the response elements
pageinteger
The current page of the results
page_sizeinteger
The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size
total_countinteger
The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.
has_next_pagebooleanOptionalRead-only
Whether there are more pages available after this page
has_previous_pagebooleanOptionalRead-only
Whether there are more pages available before this page

Errors

400
Bad Request Error