Sign inGet Started

bird amb businesses list

Usage

Codevoorbeeld
bird amb businesses list [flags]

Description

Lists the Apple businesses registered in your workspace, with cursor pagination. Requires business-management read permission. Read a business's approval state before sending as it.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Codevoorbeeld
bird amb businesses list
bird amb businesses list | jq -r '.data[].id'
bird amb businesses list --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.
--include-totalWhen 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.
--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. Defaults to created_at. 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 amb businesses createCreate an Apple Messages for Business record
bird amb businesses getGet an Apple Messages for Business record
bird amb businesses updateUpdate an Apple Messages for Business record

Gerelateerde bronnen

Ga verder met de documentatie, gidsen en voorbeelden voor dit onderwerp. De bronnen zijn in het Engels.

Ontvang een implementatieoverzicht