List audiences
GET
/v1/audiences
curl -X GET "https://us1.platform.bird.com/v1/audiences" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"Returns a paginated list of audiences in the workspace, newest first.
Parâmetros de consulta
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Payload de resposta
data
array of object
obrigatório
Page of audience objects.
Mostrar atributos secundários
data.id
string
obrigatório
Audience ID.
data.name
string
obrigatório
Display name for the audience.
data.description
nullable string
Longer description of who this audience is.
data.type
string
obrigatório
How the audience's recipients are determined. static audiences have an explicit member list you manage via the API. dynamic and external are preview values and currently unavailable — creating an audience with either returns an error.
data.created_at
string
obrigatório
data.updated_at
string
obrigatório
next_cursor
nullable string
obrigatório
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obrigatório
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obrigatório
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.