Sign in
Email Messages

List email messages

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

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

Changed in 8 of the 99 revisions of this API.31916

  • 16bfa298dc71105See 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 gw_reject 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 quarantine_expired enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the new optional query request parameter filter[metadata]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[tags]

      new-optional-request-parameter

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

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

  • 9621f6123ebc2See 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 domain_graduation_limit_exceeded enum value to the // response property for the response status

      response-property-enum-value-added

  • a6a61a29ecdd1See the full diff
    • ○

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

      response-optional-property-added

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

  • b1bf96d8391e138See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

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

      response-property-enum-value-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

  • 2fb3b617430a21See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • b3c5aebde44c12See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

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

  • 6ef0ae248bf71See the full diff
    • ○

      endpoint added

      endpoint-added

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

  • 224ed0d8a5c31See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

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

Of the 99 revisions, 1 has no diff computed.