Email Messages

List email messages

Changed on

Lists messages sorted newest first by created_at desc, id desc. Tags and metadata filters compose with cursor pagination. The legacy /v2/emails GET route is a backward-compatible alias for this operation.

get/email_messages

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/email_messages
  • Auth: HTTP bearer

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.

filter[tags]string

Comma-separated tags. Each segment is trimmed, and messages having at least one supplied tag are returned; matching is exact and case-sensitive after trimming. Because commas delimit values and surrounding whitespace is removed, this filter cannot represent stored tags containing literal commas or leading/trailing whitespace. An empty value omits the filter. Empty segments and non-string/nested query shapes return HTTP 400.

filter[metadata]string

Metadata containment filter, supplied as a JSON object or comma-separated key=value pairs. All supplied key/value pairs must be contained in the message metadata. An empty value or empty JSON object omits the filter. Malformed values, valid non-object JSON, pairs without =, empty keys, and non-string/nested query shapes return HTTP 400.

Response

Paginated list of email messages.

Example response

{
  "data": [
    {
      "recipient_statuses": {
        "delivered": 998,
        "bounced": 2
      }
    }
  ]
}

Changes

  • 16bfa298dc71Revision changes
    • warning

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

    • warning

      added the new gw_reject 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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the new optional query request parameter filter[metadata]

    • info

      added the new optional query request parameter filter[tags]

    • info

      added the non-success response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 9621f6123ebcRevision changes
    • 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