Skip to content
Extrovert Extrovert Docs

List every inbox in the org

GET
/v1/admin/orgs/{org_id}/projects/{project_id}/inboxes

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
org_id
required
string
project_id
required
string

Query Parameters

Section titled “Query Parameters ”
q
string
<= 254 characters

Case-insensitive literal email address search.

address
string

Exact inbox email address.

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.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Ok

object
inboxes
Array<object>
object
id

Stable inbox ID used for explicit connection consent.

string
address
string
display_name

Normalized sender name; empty means bare-address API mail.

string
agent_id
string
agent_name

Human-readable owning persona name.

string
lifecycle_status

Current inbox lifecycle status.

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 SMTP through the review pipeline. Effective access also requires an active paid entitlement.

boolean
created_at
string format: date-time
next_page
string

401

Section titled “401 ”

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
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean