cURL
curl -X GET "https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456/prospects" \
-H "Authorization: Bearer $EMAILX_API_KEY"import os, requests
response = requests.get(
"https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456/prospects",
headers={"Authorization": "Bearer " + os.environ["EMAILX_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json())const response = await fetch("https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456/prospects", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.EMAILX_API_KEY}` },
signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`Emailx: ${response.status}`);
console.log(await response.json());{
"data": [
{
"id": 901,
"campaign_id": 456,
"provider_id": "docs_resolved_provider_id",
"first_name": "Alex",
"last_name": "Rivera",
"status": "PENDING"
}
],
"has_more": false,
"next_cursor": null
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}Add prospects
List a campaign’s prospects
Lists the people in a campaign and their status.
Permission: campaigns:read
GET
/
workspaces
/
{workspace_id}
/
campaigns
/
{channel}
/
{campaign_id}
/
prospects
cURL
curl -X GET "https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456/prospects" \
-H "Authorization: Bearer $EMAILX_API_KEY"import os, requests
response = requests.get(
"https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456/prospects",
headers={"Authorization": "Bearer " + os.environ["EMAILX_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json())const response = await fetch("https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456/prospects", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.EMAILX_API_KEY}` },
signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`Emailx: ${response.status}`);
console.log(await response.json());{
"data": [
{
"id": 901,
"campaign_id": 456,
"provider_id": "docs_resolved_provider_id",
"first_name": "Alex",
"last_name": "Rivera",
"status": "PENDING"
}
],
"has_more": false,
"next_cursor": null
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}Authorizations
ex_test_ or ex_live_ key issued by an Emailx operator. Never use provider keys or session cookies.
Path Parameters
Emailx workspace (Clients) ID, not the agency workspace link ID.
Required range:
x >= 1Resource identifier.
Available options:
email, linkedin Resource identifier.
Required range:
x >= 1Query Parameters
Required range:
1 <= x <= 100Opaque next_cursor from the previous response. Keep filters unchanged.

