Sign in
Email Messages

List email messages

Lists messages sorted newest first by created_at desc, id desc. No filters other than cursor pagination are implemented. 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.

Response

Paginated list of email messages.

Example response

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

Changes

Changed in 5 of the 61 revisions of this API.3710

  • b1bf96d8391e138See the full diff
    • ▲

      removed the required property data/items/inserted_at from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property data/items/send_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/suppressed from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new daily_limit_exceeded enum value to the data/items/events/items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property data/items/recipient_statuses to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/scheduled_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property data/items/attachments/items/content_id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/attachments/items/disposition to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/attachments/items/sha256 to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/attachments/items/size_bytes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/attachments/items/url to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/created_at to the response with the 200 status

      response-required-property-added

  • 2fb3b617430a21See the full diff
    • ●

      added the new recipient_suppressed enum value to the errors/items/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new reputation_suspended enum value to the errors/items/code response property for the response status 401

      response-property-enum-value-added

    • ○

      added the optional property suppressed to the response with the 401 status

      response-optional-property-added

  • b3c5aebde44c12See the full diff
    • ▲

      removed the required property data/items/idempotency_key from the response with the 200 status

      response-required-property-removed

    • ●

      added the new 10027 enum value to the errors/items/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new 10036 enum value to the errors/items/code response property for the response status 401

      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