Skip to main content
GET
Get account state, capabilities and limits
Requires the agent-onboarding API release. See Set up your agent for credential handling, safe retries and the human claim flow. Check sending_status and capabilities.send before attempting to send. A claimed account can still be paused. usage.received_messages and usage.received_bytes track the onboarding receive quota, not lifetime or billing usage after claim. An expired account can read its status here but cannot read inbox/message contents.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Current account state.

tenant_id
string
required
name
string
required
onboarding_state
enum<string>
required
Available options:
unclaimed,
claimed
claimed_at
string<date-time> | null
required
sending_enabled_at
string<date-time> | null
required

Claim-time start of sending warmup for agent-created accounts.

unclaimed_expires_at
string<date-time> | null
required
expired
boolean
required
capabilities
object
required
limits
object
required
usage
object
required

Counters consumed by the unclaimed onboarding receive quota. These are not lifetime or billing usage after claim.

inboxes
object[]
required
sending_status
enum<string>
required

Current sending readiness. Check this together with capabilities.send; enabled remains subject to plan, warming, suppression and abuse checks.

Available options:
enabled,
paused,
unclaimed,
expired,
suspended
sending_paused_at
string<date-time> | null
required

When sending was paused, or null if no current pause is recorded.