Skip to main content
GET
/
api
/
public
/
v1
/
sender-accounts
/
{inbox_id}
Get sender account
curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/sender-accounts/{inbox_id} \
  --header 'X-API-Key: <api-key>'
{
  "inbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email_address": "<string>",
  "display_name": "<string>",
  "inbox_type": "<string>",
  "overall_status": "<string>",
  "daily_limit": 123,
  "emails_sent_today": 123,
  "health_score": 123,
  "domain": {
    "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "domain_name": "<string>"
  },
  "smtp_host": "<string>",
  "smtp_port": 123,
  "smtp_use_tls": true,
  "imap_host": "<string>",
  "imap_port": 123,
  "imap_use_ssl": true,
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

inbox_id
string<uuid>
required

Query Parameters

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)

domain
SenderAccountDomainInfo · object
required

Domain info (for ColdSend inboxes)

smtp_host
string | null
required

SMTP host (for workspace inboxes)

smtp_port
integer | null
required

SMTP port

smtp_use_tls
boolean | null
required

Whether TLS is enabled

imap_host
string | null
required

IMAP host (for workspace inboxes)

imap_port
integer | null
required

IMAP port

imap_use_ssl
boolean | null
required

Whether SSL is enabled

created_at
string
required

Creation timestamp

updated_at
string | null

Last update timestamp