Docs

GET /emails/receiving

Mail received at this account’s domains, newest first. Filter by recipient, sender or date range.

Parameters

  • limit query · integer · optional
  • cursor query · string · optional
  • after query · string · optional
  • to query · string · optional
  • from query · string · optional
  • q query · string · optional
  • since query · string · optional
  • until 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[].attachment_countintegeryes
data[].fromstringyes
data[].idstringyes
data[].received_atstringyes
data[].size_bytesintegeryes
data[].subjectstring | nullyes
data[].tostringyes
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.