List recipients

get

https://production-api.shoutaboutus.com/api/v1/campaign/{campaignId}/audiences

See who's on a campaign's list, and whether each recipient's email address and phone number are valid. Use this to check a list before launching or to see progress after. Returns one entry per recipient (paginated), with totals and a data-quality summary for the whole list.

Prerequisites: a bearer token and the campaign's id.

Authentication: Partner or Account token. The campaign must belong to an account inside your own account tree; otherwise 403.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

campaignId

integer

required

Defaults to 4823

Required. The campaign's id. Digits only.

Query Params

search_value

string

length ≤ 255

Defaults to jane

Text to search for, up to 255 characters. Matches part of the value.

search_field

string

enum

Defaults to all

Where to search: email, phone, customer_name, requestor_name, company, or all (default) for all five.

Allowed:

sort_field

string

enum

Defaults to created_at

The field to sort by: created_at (default), email, phone, customer_name or requestor_name.

Allowed:

sort_by

string

enum

Defaults to desc

asc or desc (either case). Default desc.

Allowed:

page

integer

≥ 1

Defaults to 1

The page to return, from 1. Default 1.

limit

integer

≤ 100

Defaults to 10

Recipients per page, 10–100. Default 10. Values below 10 are raised to 10; above 100 returns 422.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A page of recipients, with totals for the whole list.

401The token is missing, expired or invalid.

403The campaign belongs to an account outside your tree.

404No campaign has that id.

422A filter value isn't allowed, or limit is above 100.

500Unexpected server error.