Docs

GET /emails

List messages. Every console filter is a query param here (PRD F3).

Parameters

  • status query · string · optional
  • q query · string · optional
  • from query · string · optional
  • to query · string · optional
  • domain query · string · optional
  • bounce_class query · "hard" | "soft" | "block" | "policy" · optional
  • api_key_id query · string · optional
  • template_id query · string · optional
  • since query · string · optional
  • until query · string · optional
  • limit query · integer · optional
  • cursor query · string · optional
  • after query · string · optional

Responses

  • 200 Success
  • 400 Validation error
  • 401 Missing API key
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 429 Rate limited
  • 500 Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
dataarray<object>yes
data[].api_key_idstring | nullyes
data[].attachmentsarray<object> | nullyes
data[].bccarray<string> | nullyes
data[].ccarray<string> | nullyes
data[].created_atstringyes
data[].domainstringyes
data[].fromstringyes
data[].headersobject | nullyes
data[].htmlstring | nullyes
data[].idstringyes
data[].last_event"queued" | "scheduled" | "sent" | "delivered" | "delivery_delayed" | "bounced" | … | nullyes
data[].provider_message_idstring | nullyes
data[].reply_toarray<string> | nullyes
data[].scheduled_atstring | nullyes
data[].status"queued" | "scheduled" | "sent" | "delivered" | "delivery_delayed" | "bounced" | …yes
data[].subjectstringyes
data[].tagsobject | nullyes
data[].template_idstring | nullyes
data[].template_versioninteger | nullyes
data[].textstring | nullyes
data[].toarray<string>yes
data[].updated_atstringyes
data[].warningsarray<object>yes
has_morebooleanyes
next_cursorstring | nullyes

Errors

Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.