Skip to main content
GET
Error

Authorizations

X-API-Key
string
header
required

API key authentication

Query Parameters

types
enum<string>[]

Filter events by type

Available options:
contact-created,
contact-updated,
contact-update-failed,
contact-unsubscribed,
contact-reactivated,
contact-removed-from-list,
contact-tag-removed,
email-sent,
email-bounced,
email-delivered,
email-delayed,
email-rejected,
email-complaint,
email-opened,
email-clicked,
email-skipped,
bulk-contacts-created,
bulk-contacts-updated,
bulk-contacts-unsubscribed,
bulk-contacts-bounced,
campaign-sent
source
enum<string>[]

Filter events by source

Available options:
import,
bulk,
email-campaign,
api,
forms,
zapier,
import-bme
pastDays
integer
default:30

Filter events from the last N days (1-90). Defaults to 30 when omitted. Ignored when sinceDate is provided.

Required range: 1 <= x <= 90
sinceDate
string<date-time>

Filter events created on or after the given ISO 8601 date. When provided, takes precedence over pastDays.

page
integer

page number

Required range: x >= 1
size
integer

page size

Required range: x >= 1

Response

Contact events for the account

records
object[]
total
integer