bird preferences list
Usage
代码示例
bird preferences list [flags]Description
List the workspace's stated messaging preferences (consent grants and opt-outs) as a cursor page. Filter by channel, and by handle within a channel, to look up one person before messaging them.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
代码示例
bird preferences list
bird preferences list | jq -r '.data[].id'
bird preferences list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --channel | Return only preferences on this channel. Known values: email, sms, whatsapp (others may exist). |
| --handle | Return only preferences for this exact handle: an email address or an E.164 phone number. Requires channel, since a handle only means something on its channel. |
| --response-schema | Print the fields this command returns, then exit |
Pagination
| Name | Description |
|---|---|
| --ending-before | Cursor 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. |
| --starting-after | Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order. |
Related
| Name | Description |
|---|---|
| bird preferences create | Record a preference |
| bird preferences delete | Delete a preference |
| bird preferences get | Get a preference |