WoyraDocs
Get an API key

Get a mailbox

GET/v1/mailboxes/{id}

Mailboxes · Requires an API key

Parameters

NameInDescription
idrequiredpath

Example

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

Response

200 The mailbox.

FieldTypeDescription
objectrequired"mailbox"
idrequiredstring
addressrequiredstring
domain_idrequiredstring
quota_bytesrequiredintegernullNull is no quota.
suspendedrequiredbooleanDelivery stopped; mail retained.
suspended_attimestamp
has_passwordrequiredbooleanWhether someone can sign in to the mailbox directly.
past_duerequiredbooleanThe monthly charge could not be taken from the balance. Mail still arrives; signing in and sending resume once a top-up clears it.
created_atrequiredtimestamp

Errors

StatusCodes
404not_found, product_not_offered

Also in Mailboxes