Skip to main content
GET
Get sender account details

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

inbox_id
string<uuid>
required

Sender account ID

Response

Sender account retrieved successfully

Detailed sender account response.

inbox_id
string<uuid>
required

Inbox ID

email_address
string
required

Email address

display_name
string
required

Display name

inbox_type
string
required

Inbox type

overall_status
string
required

Overall status

daily_limit
integer
required

Daily sending limit

emails_sent_today
integer
required

Emails sent today

health_score
number
required

Health score (0-100)

created_at
string
required

Creation timestamp

domain
SenderAccountDomainInfo · object | null

Domain info (for ColdSend inboxes)

smtp_host
string | null

SMTP host (for workspace inboxes)

smtp_port
integer | null

SMTP port

smtp_use_tls
boolean | null

Whether TLS is enabled

imap_host
string | null

IMAP host (for workspace inboxes)

imap_port
integer | null

IMAP port

imap_use_ssl
boolean | null

Whether SSL is enabled

oauth_provider
string | null

OAuth provider if connected via OAuth

oauth_config_id
string<uuid> | null

OAuth configuration ID if using private infrastructure

updated_at
string | null

Last update timestamp