Skip to content
Sendtier Docs
Dashboard

Get one inbox

Requires a full-scope key. Another tenant, the other mode, or a deleted inbox is not found.

GET/v1/inboxes/{inbox_id}

Path parameters

ParameterDescription
inbox_idrequired
string
Full parameter schemas and constraints

Path Parameters

inbox_id*string

Authorization

headerAuthorizationBearer <token>

API key: st_live_... or st_test_...

Response Body

The inbox.

application/json
  1. response
id*string
address*string
username*string
domain*string
display_name*string
Lengthlength <= 64
retention_days*integer
Range1 <= value
test_mode*boolean

Mode of the key or dashboard session that created the inbox. It never changes.

created_at*string
Formatdate-time