v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
events

Get event by ID

Returns an Event object.

get/events/{event_id}

Path parameters

event_idstring uuid required

The ID of the event.

Response

The requested Event.

event_idstring uuid required

The ID of the event.

actor_user_idstring uuid required

The ID of the actor user.

actor_namestring string required

The name of the actor user.

actor_emailstring

The email of the actor user.

event_typestring required

The event type.

created_atstring date-time required

The day and time the event was created.

actor_ip_addressstring

The IP address of the event actor.

api_token_namestring

The name of the API token used to create the event.

api_token_previewstring

The preview of the API token used to create the event.

Example response

{
  "event_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
  "actor_user_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
  "created_at": "2022-01-23T04:56:07Z",
  "event_type": "USERS_CREATED"
}