Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Query Parameters

cursor
string

Opaque cursor from a previous response to fetch the next page

Pattern: ^[cC][^\s-]{8,}$
limit
integer
default:20

Maximum number of items to return per page (1–100, default 20)

Required range: 1 <= x <= 100
query
string

Free-text search query to filter inboxes by email or display name

agentId
string

Filter to the inboxes belonging to one agent. Omit for every inbox in the org, including unassigned ones — an inbox's agent is nullable, and deleting an agent leaves its inboxes behind rather than removing them.

Pattern: ^[cC][^\s-]{8,}$

Response

200 - application/json

OK

Paginated list of inboxes

items
object[]
required

Array of inbox resources matching the query

pagination
object
required

Pagination metadata for retrieving additional pages