Sign in
Email Messages

List events for an email message

Lists events for a single message sorted oldest first by occurred_at asc, id asc. The legacy /v2/emails/{id}/events GET route is a backward-compatible alias.

For compatibility, each event carries the legacy customer-visible event_type (email.-prefixed), the additive canonical_event_type (email.-prefixed), and the deprecated type duplicate — whose value keeps the exact legacy format: the bare stored event name, never email.-prefixed. Gateway rejections render email.failed + canonical email.gw_reject; MTA expirations render email.bounced + canonical email.expired; every unchanged outcome carries identical event_type and canonical_event_type values (and type keeps the stored name).

get/email_messages/{email_id}/events

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.

Response

Paginated list of message events.

Example response

{
  "data": [
    {
      "event_type": "email.delivered",
      "canonical_event_type": "email.delivered"
    }
  ]
}

Changes

Changed in 7 of the 99 revisions of this API.21323

  • 16bfa298dc71120See the full diff
    • ▲

      the // response's property type changed from string to no type for status

      response-property-type-changed

    • ○

      added to the // response property allOf list for the response status

      response-property-all-of-added

    • ○

      response property data/items/type deprecated

      response-property-deprecated

    • ○

      removed the bounced enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the cancelled enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the clicked enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the complained enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the daily_limit_exceeded enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the deferred enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the delivered enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the failed enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the opened enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the queued enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the rejected enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the sandbox enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the scheduled enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the sending enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the sent enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the unsubscribed enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      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

  • 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
    • ●

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

      response-property-enum-value-added

  • 2fb3b617430a42See 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 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 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

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • b3c5aebde44c4See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

      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

    • ●

      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.