Mailboxes

List mailboxes

Returns summaries of the mailboxes the caller can read, newest first, filterable by creation time (`after`, `before`).

GET
/v1/mailboxes

Returns summaries of the mailboxes the caller can read, newest first, filterable by creation time (after, before). Pass nextCursor back as cursor for the next page; it is null on the last page. Read a mailbox's addresses and metadata with GET /v1/mailboxes/{id}.

x-api-key<token>

In: header

Query Parameters

limit?string|null
cursor?CursorEncoded|null
after?string|null
before?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/mailboxes"
{  "items": [    {      "id": "string",      "namespaceId": "string",      "slug": "string",      "displayName": "string",      "status": "active",      "primaryAddress": "string",      "createdAt": "string"    }  ],  "nextCursor": "string"}

Related documentation