Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Unique inbox identifier

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

200 - application/json

OK

Inbox resource representation

id
string
required

Unique identifier of the inbox

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
email
string<email>
required

Full email address of the inbox

domain
string
required

Domain portion of the inbox email address

localPart
string
required

Local part (before the @) of the inbox email address

displayName
string | null
required

Human-readable display name, or null if not set

agentId
string | null
required

ID of the associated agent, or null if unassigned

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
createdAt
string<date-time>
required

Timestamp when the inbox was created