List every audience
/v1/projects/{project}/broadcasts/audiences in the Broadcasts API.
All thirteen segments with labels, descriptions and current counts, so a UI can offer them without hard-coding the list. Segments that address a single window report recipient_estimate: null; they cannot be sized without a window id.
| Field | Type | Meaning |
|---|---|---|
value | string | The segment key to send as audience. |
label, description | string | The words the dashboard shows, in the creator's language. |
requires_pass_window | boolean | Whether the segment needs a pass_window_id. |
supports_plan_filter | boolean | Whether plan_id is accepted. False for lead and the pass segments. |
requires_expiring_within_days | boolean | Whether the segment reads a horizon. True only for expiring_soon. |
recipient_estimate | integer or null | Who the segment reaches right now; null where a window must be named first. |
Requires ability
The token must hold this ability, or the call is refused with 403.
Authorization
bearerToken A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.
In: header
Path Parameters
The project, resolved by the route binder.
uuidResponses
200OKapplication/json
Every segment with its label, its rules and a recipient estimate where one can be given without a window.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on