---
title: "List every audience"
method: GET
path: "/v1/projects/{project}/broadcasts/audiences"
tags: ["Broadcasts"]
---

# List every audience

`GET /v1/projects/{project}/broadcasts/audiences`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/broadcasts/audiences`
- Auth: HTTP bearer

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.      |

## Path parameters

- `project` string, uuid, required

## Response `200`

Every segment with its label, its rules and a recipient estimate where one can be given without a window.

- object
  - `data` unknown[], required: The items.
    - unknown

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: 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.
- `404`: `RESOURCE_NOT_FOUND`: 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.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)