Skip to content

List Inbox Mailboxes

GET
/inbox/mailboxes

Mailboxes with their AI Inbox sync state.

Each row carries the mailbox record PLUS cron_status, auto_respond, is_supported, has_credential_error and last_unread_limit - the inbox-only columns /mailboxes does not have.

Authorizations

Parameters

Query Parameters

user_email
Any of:
string

Whose PERSONAL mailboxes to include. Defaults to the human who minted this key. An org-scoped key has no human, so it sees the team mailboxes only.

provider
Any of:
string
Allowed values: google_mailbox smtp

Filter by connection type.

category
Any of:
string
Allowed values: team personal

team (shared) or personal (owner-only).

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