Skip to main content
GET
List senders

Authorizations

X-API-Key
string
header
required

Query Parameters

search
string | null
Maximum string length: 255

Response

Successful Response

booking_url
string | null
required

The link people use to book a meeting with this sender, such as a Calendly or Cal.com page. It is what the {{Sender booking link}} variable is replaced with. Null when none is set.

created_at
string<date-time>
required
id
string<uuid>
required
mailbox_count
integer
required
name
string
required
send_mode
enum<string>
required

Whether the messages the agent writes for this sender go out on their own or wait for a person, replies included. Always send (always_send): the agent's messages go out on their own unless something is wrong with the words. Send when confident (send_when_confident, the default): they go out when the agent was confident and nothing is wrong, and wait for a person otherwise. Always ask (always_ask): a person approves every one. A sequence set to ask first still asks, whichever mode its senders are on.

Available options:
always_send,
send_when_confident,
always_ask
status
enum<string>
required

Lifecycle of a sender.

A sender is DRAFT from the moment it is created and becomes ACTIVE once at least one mailbox is attached. The status is derived from attachment, never stored — it cannot drift.

Available options:
draft,
active
title
string
required

The sender's job title, as their messages introduce them. It is what the {{Sender title}} variable is replaced with. Empty when none is set.

updated_at
string<date-time>
required
daily_limit
integer
default:0
email_approval_mode
enum<string> | null

manual | auto; null inherits the workspace's email approval mode.

Available options:
manual,
auto
first_name
string
default:""
last_name
string
default:""
linkedin_connection_request_cap
integer
default:0
linkedin_connection_requests_today
integer
default:0
linkedin_identity
string | null
linkedin_photo_url
string | null
linkedin_presence
enum<string> | null

How recently ANY browser connected to this sender checked in.

Three states, not two, because two different questions are asked of a connection. ACTIVE answers "can a step run right now" — a browser is open and heartbeating. IDLE answers "is this still set up" — the laptop was closed for the evening. NOT_SEEN is the one that needs a person: nothing has checked in for a day, and queued work is silently waiting.

Available options:
active,
idle,
not_seen
sent_today
integer
default:0
signature_text
string
default:""