Skip to main content
GET
Get mailboxes

Authorizations

Authorization
string
header
required

Path Parameters

workspaceID
string
required

Workspace ID

Query Parameters

limit
integer
default:10

Limit

offset
integer
default:0

Offset

statuses[]
enum<string>[]

Filter by status

Available options:
active,
access_lost,
pending
mailbox_ids[]
string[]

Filter by mailbox IDs

excluded_mailbox_ids[]
string[]

Exclude mailbox IDs

Search query

tag_ids[]
string[]

Filter by tag IDs

not_tag_ids[]
string[]

Exclude tag IDs

addresses[]
string[]

Filter by mailbox addresses

status_criteria
enum<string>
default:all

Status criteria

Available options:
all,
active,
warm,
pending,
suspended,
disconnected,
recommendations
statuses_criteria
enum<string>[]

Statuses criteria

Available options:
all,
active,
warm,
pending,
suspended,
disconnected,
recommendations

Response

List of mailboxes

data
object[]
limit
integer
offset
integer
total
integer