Email Messages

List recipients for an email message

Changed on

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

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/email_messages/{email_id}/recipients
  • Auth: HTTP bearer

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

  • 16bfa298dc71Revision changes
    • warning

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

    • warning

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

    • info

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

    • info

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

  • 9621f6123ebcRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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