fetch a page of contactable worker uuids for audience within a given audience, ordered by member id
Answers 409 (code #0bd97eaf) while the audience's first refresh is running, or when no refresh has completed and it stores no members, and 409 (code #4a42ac7d) when it stores no members and its refresh is blocked and will not finish by waiting. Answers 422 for an invalid campaignUuid, and (code #cc94968c) for a page whose filter[skip] plus filter[limit] passes 15000. A page that takes too long to read answers 500 with code #1bb941b5; retry with a smaller window.
Request
- Base URLhttps://services.fountain.com
- URLhttps://services.fountain.com/api/servicepool/audiences/{identifier}/workerUuids
- AuthHTTP bearer
Path parameters
audience unique identifier
Query parameters
uuid of a campaign on this audience — its channel is resolved server-side and used to filter contactable recipients. Excludes talent Hire has suppressed, or that opted out, on that channel. This filter narrows results only when channel enforcement is enabled for the tenant; omitting the parameter always returns every visible recipient. When channel enforcement is disabled for the tenant, the campaign is never looked up — an unknown or mismatched campaignUuid returns every visible recipient instead of a 404.
Pages the audience members: filter[limit] is the page size (default 100, maximum 1000) and filter[skip] the number of members to pass. A page shorter than the limit is the last one. A request whose skip plus limit passes 15000 answers 422. Pages taken while the audience membership changes can skip or repeat a member.
Response
one page of contactable worker uuids for a given audience
Example response
{
"meta": {
"timestamp": "2021-05-05T09:47:58.924Z",
"verb": "GET",
"path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
"jti": "%cQN3RIGp",
"rid": "$2d2zkHZ5",
"count": 1,
"status": "200",
"duration": 17,
"size": 1234
}
}Changes
No recorded changes to this operation across all 1 revision of this API.