v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB

Events

List all events

List all event objects.

get/v1/event

Query parameters

eventsEventType[]

Return events of these type.

ID of the Event object you want to retrieve.

afterstring date-time

Return objects where the created_at timestamp is after the entered timestamp.

on_or_afterstring date-time

Return objects where the created_at timestamp is the same as or after the entered timestamp.

beforestring date-time

Return objects where the created_at timestamp is before the entered timestamp.

on_or_beforestring date-time

Return objects where the created_at timestamp is the same as or before the entered timestamp.

A set of filters on the list using the object’s field created_at.

limitinteger

Maximum number of objects to be returned.

starting_afterstring

A cursor for use in pagination; this is an Event ID that defines your place in the list.

ending_beforestring

A cursor for use in pagination; this is an Event ID that defines your place in the list.

object_idstring

Example:wire_12345

Filter events by the ID of the associated object (e.g., wire_12345). If the object_id doesn't match the event filter's object type, returns empty results.

Response

A list of events

has_moreboolean required

Indicates whether more results are available.