Skip to main content
GET
Get sender

Authorizations

Authorization
string
header
required

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

Path Parameters

senderId
string
required

Response

Sender details.

id
string
required
Example:

"sender_12345"

name
string
required
Example:

"Primary sender"

phoneNumber
string
required

Phone number in E.164 format.

Example:

"+13125551212"

channels
string[]

Channels this sender can actually send on right now, computed from its configuration. Empty means the sender cannot send or receive anything yet: a phoneNumber alone does not enable SMS or voice. Check this rather than inferring capability from phoneNumber or emailAddress.

Example:
isDefault
boolean
default:false

Whether this sender is the project's default.

webhook
object

Webhook configuration for the sender.

whatsapp
object

WhatsApp Business Account information. Only present if a WABA is connected.

emailAddress
string

From-address for the email channel, if configured.

Example:

"noreply@yourdomain.com"

emailReceivingEnabled
boolean
default:false

Whether inbound email receiving is enabled for this sender.

emailCatchAllEnabled
boolean
default:false

Whether catch-all receiving is enabled. When true (and emailReceivingEnabled is true), this sender receives email addressed to any local part at its domain, not just its own address. The original recipient is delivered in the message.inbound webhook's data.to.

createdAt
string<date-time>
updatedAt
string<date-time>