WoyraDocs
Get an API key

Mail received on your domains

GET/v1/emails/inbound

Emails · Requires an API key

Every message delivered to an address on one of your verified domains, newest first, bodies included. A domain receives once its MX record points at Woyra (the record is in the domain's records); nothing else is set up, and every address on the domain is an inbox.

Each message also arrives as an email.received webhook when it is stored, carrying the text (up to 10,000 characters), the attachment list and, for a reply to something you sent, the id of that email. Requires emails:read.

Parameters

NameInDescription
limitquery
cursorqueryThe next_cursor from the previous page.
Woyra-VersionheaderThe dated API version to serve. Omit to pin to the oldest supported version.

Example

curl https://api.woyra.io/v1/emails/inbound \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 A page of received emails.

FieldTypeDescription
object"list"
dataarray of InboundEmail
has_moreboolean
next_cursorstring

Errors

StatusCodes
401authentication_required, invalid_api_key
403insufficient_scope, domain_not_verified, recipient_suppressed, sending_paused, mfa_required

Also in Emails