List audiences
GET
/v1/audiences
curl -X GET "https://us1.platform.bird.com/v1/audiences" \
-H "Authorization: Bearer $TOKEN" \
--url-query "q=newsletter" \
--url-query "limit=25"Returns a paginated list of audiences in the workspace, newest first. Filter to audiences whose name contains a substring with q.
Query Parameters
q
string
Case-insensitive substring match against the audience's name.
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.
Response Payload
data
array of object
required
Page of audience objects.
Show child attributes
data.id
string
required
ID of the audience (adn_-prefixed), accepted by every operation that takes an audience_id.
data.name
string
required
Display name for the audience.
data.description
nullable string
Longer description of who this audience is.
data.type
string
required
How the audience's recipients are determined. static (the default) is an explicit member list you manage via the API. dynamic and external are preview values and currently unavailable; creating an audience with either returns a validation error.
Possible values: static, dynamic, external
data.created_at
string
required
data.updated_at
string
required
next_cursor
nullable string
required
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
required
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
required
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.