Skip to content

List every inbox in the org

GET
/v1/admin/orgs/{org_id}/projects/{project_id}/inboxes
org_id
required
string
project_id
required
string
limit
integer
default: 50 >= 1 <= 100

Page size for the cursor-paginated agent surface (default 50; clamped to the 1-100 range).

page
string

Opaque page token echoed back from a prior next_page. Used by the legacy offset-paginated admin/console list surface; the cursor-paginated agent surface uses Cursor (?cursor) instead.

Ok

object
inboxes
Array<object>
object
address
string
agent_id
string
domain
string
webhook_url
string
daily_send_used

Recipients sent in the rolling 24-hour window.

integer
daily_send_cap
integer
direct_smtp_enabled

Whether this inbox is configured for direct SMTP outside the review pipeline. Effective access also requires an active paid entitlement.

boolean
created_at
string format: date-time
next_page
string

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope