Skip to content

List Inbox Mailboxes Paginated

GET
/inbox/mailboxes/paginated

Mailboxes with their sync state, paged and filterable - the settings screen’s list.

Every VISIBLE mailbox is returned, disconnected ones included, and each is annotated with can_send / send_blocked_reason for THIS caller, so a mailbox the key may see but not send from is distinguishable before a send is attempted. total_count carries the unpaged total. Credentials are scrubbed from every row.

Authorizations

Parameters

Query Parameters

page
integer
default: 1 >= 1
page_size
integer
default: 20 >= 1 <= 100
status
Any of:
string
Allowed values: RUNNING STOPPED

RUNNING (being polled) or STOPPED.

provider
Any of:
string
Allowed values: google_mailbox smtp

Filter by connection type.

search
Any of:
string

Substring of the mailbox address.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open LIST envelope: a bare list, or a named list, is reachable as items, and every other key the app returned (totals, pagination) is kept.

object
items
Array
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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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