Skip to main content
GET
List mailboxes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

domainUuid
string<uuid>

Only return mailboxes hosted on this domain.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
folderUuid
string<uuid> | null

Filter by folder. Use null to list mailboxes that are not in any folder.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
statuses
enum<string>[]

Optional status filter.

Available options:
pending,
active,
inactive
limit
integer

Maximum number of mailboxes to return.

Required range: x <= 1000
offset
integer

Number of mailboxes to skip.

Required range: 0 <= x <= 9007199254740991

Response

Successful response

mailboxes
Mailboxes · object[]
required

Mailboxes owned by the workspace.