Skip to main content
GET
The identities this workspace can send from, on any channel

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Query Parameters

channel
enum<string>

Restrict to one channel. Omit for every channel at once.

Available options:
whatsapp,
sms,
call,
email
sendable_only
boolean
default:false

Only senders that can originate a message

queue_uuid
string<uuid>

Only senders routed to this queue

distinct
enum<string>

identifier collapses the list to one row per address. Use it when the picker is about the number the customer sees rather than which agent sends — on voice a caller ID can be bound to several agents. The surviving row is chosen by a fixed rule (sendable first, then the agent the queue designer routes that endpoint to, then the oldest binding), so the same address always resolves to the same agent_uuid. Collapsed rows carry an agents array listing everyone bound to that address.

Available options:
identifier

Response

Senders retrieved

success
boolean
Example:

true

message
string
Example:

"Senders retrieved successfully"

data
object[]