List a broadcast's recipients
Who the broadcast goes to, in the order it sends: a book broadcast's subscribed contacts, or a segment broadcast's subscribed matches (live until the…
https://app.usenotix.dev/api/v1/broadcasts/{broadcastId}/recipientsFull access and read only keys can call this. Sending access keys cannot. Key permissions lists the extra rules some calls have.
Who the broadcast goes to, in the order it sends: a book broadcast's subscribed contacts, or a segment broadcast's subscribed matches (live until the send starts, then the list frozen at that moment, frozen: true). Each has its contact id, address and name. Pass nextCursor back as cursor for the next page; limit is 1 to 100 (50 by default). Suppressed addresses are listed and skipped when the send reaches them. A read longer than 10 seconds answers 422. At most three run at once for a team: a fourth answers 429, and 503 when that cannot be checked.
Who can call it
A full access key that is not limited to one domain: contacts carry no domain, so a key limited to one would read the whole team's list. A read-only or live AI key answers 403. The team can read recipients 30 times a minute.
Path parameters
Query parameters
nextCursor from the previous page.
Recipients per page, 1 to 100. Defaults to 50.
Minimum 1. Maximum 100. Default 50.
Headers
Bearer followed by your API key.
Errors
The key is not FULL, or is limited to one domain.
No campaign with this id for the calling team (or, for a key limited to one domain, on its domain).
The segment no longer exists or has a problem, or the read took longer than 10 seconds.
The team read campaign recipients 30 times in the last minute, or three reads are already running.
The call could not be counted just now. Try again shortly.
Every error has the same shape. See all error codes.
curl -X GET "https://app.usenotix.dev/api/v1/broadcasts/<broadcastId>/recipients" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.broadcasts.recipients("cmp_123", { limit: 100 });
const next = data?.nextCursor; // pass back as cursor for the next page
{
"data": [
{
"contactId": "cm1x8f3k20001qz7v5b9d2e4a",
"email": "customer@example.com",
"firstName": "Acme",
"lastName": "Acme"
}
],
"nextCursor": "string",
"frozen": true
}