Mailboxes

Get a mailbox

Returns a mailbox with its endpoints and metadata; each endpoint says whether it is the mailbox's default on its channel. Its grants are GET /v1/mailboxes/{id}/grants and its send policies GET /v1/mailboxes/{id}/policies.

get/v1/mailboxes/{id}

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/mailboxes/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Response

Mailbox

idstring required
namespaceIdstring required
slugstring required
namestring required
status'active' | 'paused' required
primaryAddressstring nullable required
createdAtstring required
descriptionstring nullable required
metadataMailboxMetadata required
updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.