v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Email API

Search email tracking

Returns a paginated list of email log rows for your account (latest event per message when browsing the full list).

Optional query trackingId narrows results to one message's timeline (same data shape as list, filtered).

Request body accepts zero or more search filters (same pattern as SMS tracking). Combine with dateStart / dateEnd (ISO-8601, UTC) to bound the time window.

Log rows may take 1–2 minutes to appear after a successful send.

post/email/tracking

Query parameters

trackingIdstring

When set, returns log events for this message. Use the send response trackingId (primary customer id). Internal messageId is also accepted when values differ.

dateStartstring date-time

Start of date range (ISO-8601).

dateEndstring date-time

End of date range (ISO-8601).

pageinteger

sizeinteger

Headers

Authorizationstring required

Bearer {access_token}

Content-Typestring required

Request body

fieldNamestring required

Searchable fields include deliveryStatus, date, event, envelope, recipient, from, to, subject, status, messages, trackingId, messageId, type. Use query trackingId instead of a body filter when looking up one batch.

{"stackTrail":"components:schemas:SearchFilter:properties:searchTerm","oasType":"schema","type":"unknown","description":"Value to match."}

searchOperator'is' | 'is_not' | 'contains' | 'starts_with' | 'ends_with'

One of is, is_not, contains, starts_with, ends_with.

Response

Paginated tracking rows

totalElementsinteger

totalPagesinteger

sizeinteger

numberinteger