List Senders
curl --request GET \
--url https://api.lemlist.com/api/senders \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.lemlist.com/api/senders"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.lemlist.com/api/senders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://api.lemlist.com/api/senders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lemlist.com/api/senders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"campaignId": "cam_A1b2C3d4E5f6G7h8M",
"senderStrategy": "random",
"requiredChannelTypes": [
"email",
"whatsapp"
],
"senders": [
{
"userId": "usr_A1b2C3d4E5f6G7h8K",
"name": "John Doe",
"email": "john@example.com",
"inPool": true,
"channels": [
{
"type": "email",
"id": "usm_A1b2C3d4E5f6G7h8L",
"label": "john@example.com",
"aliases": [
"hello@example.com"
],
"esp": "google",
"inPool": true,
"diagnostics": []
}
],
"diagnostics": [
{
"scope": "user",
"type": "error",
"code": "no_required_channel_active",
"channelType": "whatsapp"
}
]
},
{
"userId": "usr_A1b2C3d4E5f6G7h8N",
"name": "Jane Smith",
"email": "jane@example.com",
"inPool": false,
"channels": [
{
"type": "email",
"id": "usm_A1b2C3d4E5f6G7h8P",
"label": "jane@example.com",
"esp": "microsoft",
"inPool": false,
"diagnostics": []
},
{
"type": "whatsapp",
"id": "uwa_A1b2C3d4E5f6G7h8Q",
"label": "+15550100199",
"inPool": false,
"diagnostics": []
}
],
"diagnostics": []
}
]
}
}{
"error": "Wrong param campaign id",
"code": "WRONG_PARAM_CAMPAIGN_ID"
}The authentication you supplied is incorrect{
"error": "Campaign not found",
"code": "SENDER_CAMPAIGN_NOT_FOUND"
}{
"error": "Route bad method",
"code": "ROUTE_BAD_METHOD"
}Senders
List Senders
Lists the team members who can send, with their channels and the health of each channel.
GET
/
senders
List Senders
curl --request GET \
--url https://api.lemlist.com/api/senders \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.lemlist.com/api/senders"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.lemlist.com/api/senders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://api.lemlist.com/api/senders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lemlist.com/api/senders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"campaignId": "cam_A1b2C3d4E5f6G7h8M",
"senderStrategy": "random",
"requiredChannelTypes": [
"email",
"whatsapp"
],
"senders": [
{
"userId": "usr_A1b2C3d4E5f6G7h8K",
"name": "John Doe",
"email": "john@example.com",
"inPool": true,
"channels": [
{
"type": "email",
"id": "usm_A1b2C3d4E5f6G7h8L",
"label": "john@example.com",
"aliases": [
"hello@example.com"
],
"esp": "google",
"inPool": true,
"diagnostics": []
}
],
"diagnostics": [
{
"scope": "user",
"type": "error",
"code": "no_required_channel_active",
"channelType": "whatsapp"
}
]
},
{
"userId": "usr_A1b2C3d4E5f6G7h8N",
"name": "Jane Smith",
"email": "jane@example.com",
"inPool": false,
"channels": [
{
"type": "email",
"id": "usm_A1b2C3d4E5f6G7h8P",
"label": "jane@example.com",
"esp": "microsoft",
"inPool": false,
"diagnostics": []
},
{
"type": "whatsapp",
"id": "uwa_A1b2C3d4E5f6G7h8Q",
"label": "+15550100199",
"inPool": false,
"diagnostics": []
}
],
"diagnostics": []
}
]
}
}{
"error": "Wrong param campaign id",
"code": "WRONG_PARAM_CAMPAIGN_ID"
}The authentication you supplied is incorrect{
"error": "Campaign not found",
"code": "SENDER_CAMPAIGN_NOT_FOUND"
}{
"error": "Route bad method",
"code": "ROUTE_BAD_METHOD"
}To pin the sender of one step, outside the pool, see
Set Step Sender in the
Sequences group.
- Each channel is evaluated as if a campaign used it. A disconnected account shows its diagnostic even when no campaign uses it.
- With
campaignId:inPooltells whether the campaign pool enables each sender and each channel.requiredChannelTypeslists the channel types that the campaign steps use. Only these types can be enabled in the pool.- On a dynamic sender strategy, the list keeps only the senders and the channels that the sender exclusion list of the campaign allows.
diagnostics codes are the same as in
Get Campaign Senders.Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
Adds inPool, the sender strategy and the channel types that the campaign steps use
Response
Success
The team members who can send, with their channels.
Show child attributes
Show child attributes
Was this page helpful?