Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Events

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.

get/events

Query parameters

created_afterstring date-time

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

value'asc' | 'desc'

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

value'v1' | 'v2'

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

pageinteger

The page of results to return. Defaults to 1 if not provided.

The page of results to return. Defaults to 1 if not provided.

page_sizeinteger

The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

Headers

X-Platform-Idstring

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.

Response

OK

pageinteger required

The current page of the results

page_sizeinteger required

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 required

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_pageboolean

Whether there are more pages available after this page

has_previous_pageboolean

Whether there are more pages available before this page