Skip to content

List My Mailboxes

GET
/mailboxes/my

Mailboxes created by the principal behind this key.

Hard-scoped server-side to the caller - it does not trust a client-supplied owner filter, which is what separates it from the generic mailbox list.

Authorizations

Parameters

Query Parameters

include_archived

Include archived mailboxes.

boolean

Include archived mailboxes.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
mailboxes
Array<object>

One mailbox as the inventory surfaces it.

object
channel_type
Any of:
string
email
Any of:
string
id
Any of:
integer
is_archived
Any of:
boolean
status
Any of:
string
key
additional properties
any
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string