Sign inGet Started

bird whatsapp agents allowlist list

Usage

Code example
bird whatsapp agents allowlist list <number-id> [flags]

Description

List the allowlist entries the agent on this WhatsApp number holds, as a cursor page.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

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

Options

Pagination

NameDescription
--ending-beforeCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
--limit <n>Maximum number of items to return per page. Allowed range: 1 to 100.
--orderSort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc.
--sortField to sort by. Possible values: created_at.
--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
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp agents allowlist createAdd a contact to an agent's allowlist
bird whatsapp agents allowlist deleteRemove one of an agent's allowlist entries
bird whatsapp agents allowlist getGet one of an agent's allowlist entries

Continue with the documentation, guides and examples for this topic.