bird amb business-accounts list
Usage
Code example
bird amb business-accounts list [flags]Description
Lists the Apple businesses registered in your workspace, with cursor pagination. Requires business-management read permission. Use the configured apple_business_id when sending; onboarding status does not gate messaging.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird amb business-accounts list
bird amb business-accounts list | jq -r '.data[].id'
bird amb business-accounts list --limit 50 --starting-after <cursor>Options
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. |
--include-total | When true, the response includes a total field with the total number of items matching the request's filters across all pages. |
--limit <n> | Maximum number of items to return per page. Allowed range: 1 to 100. |
--order | Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc. |
--sort | Field to sort by. Possible values: created_at. Defaults to created_at. Possible values: created_at. |
--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. |
Filters
| Name | Description |
|---|---|
--response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
bird amb business-accounts create | Create an Apple Messages for Business record |
bird amb business-accounts delete | Disconnect an Apple business account |
bird amb business-accounts get | Get an Apple Messages for Business record |
bird amb business-accounts reconnect | Reconnect an Apple business account |
bird amb business-accounts update | Update an Apple Messages for Business record |
Related resources
Continue with the documentation, guides and examples for this topic.