Sign in
Email Messages

List recipients for an email message

Lists per-recipient delivery states for a single message with cursor pagination. Each recipient has an independent status, billable flag, and lifecycle timestamps. BCC recipient addresses are redacted (returned as null) to protect BCC privacy. Default page size is 25, maximum is 100.

get/email_messages/{email_id}/recipients

Path parameters

email_idstring uuid required

Email message UUID.

Query parameters

page_sizeinteger

Number of results to return. Defaults to 25; maximum is 100. Invalid values are clamped to the valid range.

page_cursorstring

Opaque URL-safe Base64 cursor returned by a previous list response.

status'queued' | 'sending' | 'sent' | 'deferred' | 'delivered' | 'bounced' | 'failed' | 'gw_reject' | 'cancelled' | 'injection_timeout' | 'expired'

Filter recipients by status.

kind'to' | 'cc' | 'bcc'

Filter recipients by address kind.

Response

Paginated list of recipients.

Changes

Changed in 3 of the 99 revisions of this API.63

  • 16bfa298dc7122See the full diff
    • ●

      added the new expired enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new injection_timeout enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value expired to the query request parameter status

      request-parameter-enum-value-added

    • ○

      added the new enum value injection_timeout to the query request parameter status

      request-parameter-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9621f6123ebc4See the full diff
    • ●

      added the new 10011 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new 10011 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

      response-property-enum-value-added

  • b1bf96d8391e1See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 99 revisions, 1 has no diff computed.