Sign in

v4

latestOpenAPI 3.1.0MIT2026-08-02128224900.7 KB
Events

List Events

List all events

get/events

Query parameters

event_type'bounced' | 'clicked' | 'complained' | 'delivered' | 'opened' | 'rejected' | 'replied' | 'unsubscribed'

The type of a subscriber event, such as a delivery, open, click, or reply.

If provided, only return events of the given type (e.g. delivered, opened, clicked).

ordering'creation_date' | '-creation_date'

The ordering to apply to the results.

The ordering to apply to the results.

expandstring[]

If provided, expand the given field. (Only supported field: 'subscriber').

If provided, expand the given field. (Only supported field: 'subscriber').

email_idstring

If provided, only return events for the given email.

If provided, only return events for the given email.

automation_idstring

If provided, only return events for the given automation.

If provided, only return events for the given automation.

subscriber_idstring

If provided, only return events for the given subscriber.

If provided, only return events for the given subscriber.

pageinteger

The page number of the paginated response.

Example:1

The page number of the paginated response.

Response

OK

nextstring nullable

The URL to the next page of results, if any.

previousstring nullable

The URL to the previous page of results, if any.

countinteger required

The total number of results across all pages.