API Reference
List Campaign Recipients
GET /campaigns/:id/recipients — the people a campaign went to, optionally only those who opened, clicked, bounced and so on.
GET
/campaigns/:id/recipientsReturns one page of a campaign's recipients, oldest first, with each one's delivery status and engagement. Pass type to list only the recipients with one outcome. Follow-up mail is not included.
Path parameters
idstringrequiredThe campaign ID.
Query parameters
typestringoptionalOne of delivered, opened, clicked, bounced, complained, failed, suppressed. delivered includes recipients who went on to open, click or reply. Omit for every recipient.
limitnumberoptionalRows per page, 1–100. Defaults to 20.
afterstringoptionalThe id of the last recipient of the previous page. Keep paging while has_more is true.
Request
const res = await fetch('https://www.senddart.com/api/campaigns/8f5c2a1e-7b3d-4f9a-9c12-2e6d4a7b8c90/recipients?type=opened&limit=20', {
method: 'GET',
headers: { 'Authorization': 'Bearer mb_xxxxxxxxx' },
});
const data = await res.json();
console.log(data);Response
{
"object": "list",
"has_more": false,
"data": [
{
"object": "campaign_recipient",
"id": "48213",
"email": "ada@example.com",
"contact_id": "3c1f7b90-52ad-4e6b-9f01-8d4c2b6e7a13",
"status": "clicked",
"sent_at": "2026-11-20T09:00:04.512Z",
"opened_at": "2026-11-20T09:14:51.230Z",
"clicked_at": "2026-11-20T09:15:10.004Z",
"open_count": 2,
"click_count": 1
}
]
}Requires a full-access key (read scope). Errors:
not_found if the campaign does not exist or is not yours; validation_error for an unknown type or an out-of-range limit or after.