Events

List Events

Lists activity events (sends, opens, clicks, replies, etc.) with filtering by team, campaign, contact, and event type.

get/events

Query parameters

TeamIdstring uuid

Filter by team ID

CampaignIdstring uuid

Filter by campaign ID

ContactIdstring uuid

Filter by contact ID

SenderIdstring uuid

Filter by sender ID

type'scheduled' | 'sent' | 'open' | 'reply' | 'click' | 'bounce' | 'unsubscribe'

Filter by event type

channel'email' | 'linkedin' | 'text' | 'call'

Filter by channel

limitinteger

Number of items to return

offsetinteger

Number of items to skip

start_datestring date-time

Filter events after this date (ISO 8601). When omitted with no end_date, defaults to 30 days ago.

end_datestring date-time

Filter events before this date (ISO 8601). When both start_date and end_date are provided, the gap cannot exceed 90 days.

Response

List of events

successboolean
request_idstring

Example response

{
  "success": true,
  "request_id": "req_abc123def456"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.