v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Events

Retrieve an event

Retrieve an event object. Events are available for up to 30 days.

The 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/{event_id}

Path parameters

event_idstring required
Example:evt_3b1333d87d9d4fd6ad83ba7f6b0e951a

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

idstring required
platform_idstring required
createdstring date-time required
typestring required
api_versionstring