Skip to navigation
EventsCustom events

Get events

View as Markdown

This endpoint currently only supports custom events.

Retrieve a list of events filtered by various criteria.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app's client_id/client_secret for a short-lived Bearer token.

Query parameters

contact_idlist of longsOptional

Filter by contact ID (repeatable)

event_namelist of stringsOptional

Filter by event name (repeatable)

object_typelist of stringsOptional

Filter by object type (repeatable)

startDatestringOptional

Mandatory if endDate is used. Start of date range (YYYY-MM-DD or RFC3339). Defaults to 6 months ago when omitted alongside endDate. Must be ≤ endDate.

endDatestringOptional

Mandatory if startDate is used. End of date range (YYYY-MM-DD or RFC3339). Must be ≥ startDate.

limitintegerOptional1-10000Defaults to 100
Max events to return. Default 100, min 1, max 10000.
offsetintegerOptional>=0Defaults to 0
Events to skip for pagination. Default 0, min 0.

Response

List of events and total count for pagination
countlong

Total count of events matching the filters (use for pagination)

eventslist of objectsOptional

List of matching events ordered by event_date descending

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error