Documentation
Sign inGet started

bird audiences list

Usage

Code example
bird audiences list [flags]

Description

List the workspace's audiences as a cursor page, newest first. Filter by name substring with q.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Code example
bird audiences list
bird audiences list | jq -r '.data[].id'
bird audiences list --limit 50 --starting-after <cursor>

Options

Pagination

NameDescription
--ending-beforeCursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
--limit <n>Maximum number of items to return per page.
--starting-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

Filters

NameDescription
--qCase-insensitive substring match against the audience's name.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird audiences add-contactsAdd contacts to a static audience.
bird audiences createCreate an audience.
bird audiences deleteDelete an audience
bird audiences getGet an audience
bird audiences list-contactsList an audience's contacts
bird audiences remove-contactRemove a contact from an audience
bird audiences remove-contactsRemove contacts from a static audience.
bird audiences updateUpdate an audience's name or description.