v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Audiences

Get audiences

Unified audience read. Omit audienceId to LIST the brand’s saved audiences under { data, pagination }. Each row carries its contact filters, the cached member count, and ISO timestamps. An audience is the recipient target for POST /v1/sends. Pass ?audienceId= to fetch ONE — returns { data: [row] } (no pagination), 404 AUDIENCE_NOT_FOUND on an unknown / cross-brand id. Add ?include=count (detail only) to replace the cached count with a freshly computed member total.

get/v1/audiences

Query parameters

audienceIdstring

Fetch a single audience by id (detail mode → { data: [row] }). Omit to list.

include'count'

Detail-only expansion: count recomputes the live member total. Rejected without audienceId.

limitinteger

Page size (1–100). Defaults to 100.

cursorstring

Opaque pagination cursor echoed from the previous page’s pagination.cursor. Omit for the first page.

Response

A page of audiences (list mode), or { data: [row] } (detail mode).