List Apple Messages for Business records

GET

/v1/amb/business-accounts

const result = await bird.amb.businessAccounts.list({ limit: 2 });
console.log(result);

result = client.amb.business_accounts.list(limit=2)
print(result)

for item, err := range client.Amb.BusinessAccounts.List(ctx, bird.AmbBusinessAccountsListParams{Limit: 2}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(item)
}

foreach ($bird->amb->businessAccounts->list(['limit' => '2']) as $item) {
    var_dump($item);
}

bird amb business-accounts list

curl -X GET "https://us1.platform.bird.com/v1/amb/business-accounts" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=created_at" \
  --url-query "order=desc" \
  --url-query "limit=25" \
  --url-query "include_total=false"

Réponse200

{
  "data": [
    {
      "id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "apple_business_id": "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
      "name": "Acme Retail",
      "status": "active",
      "invitations_enabled": false,
      "created_at": "2026-08-20T09:14:52Z",
      "updated_at": "2026-08-25T16:42:01Z",
      "next": [
        {
          "kind": "operation"
        }
      ],
      "account_review_status": "approved"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns a paginated list of your workspace's Apple Messages for Business records. A workspace can register multiple businesses.

Paramètres de requête

sortstring

Field to sort by. Possible values: created_at. Defaults to created_at.

Possible values: created_at

orderstring

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

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

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_totalboolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

Contenu de la réponse

data

array of object

obligatoire

The business records your workspace holds.

Afficher les attributs enfants

data.id

string

obligatoire

Unique identifier for the business record.

data.apple_business_id

nullable string

obligatoire

Apple business UUID, or null until supplied. Adding this identifier does not submit the account for review.

data.name

string

obligatoire

Customer-supplied account name used in Bird. Apple controls the name shown to customers in Messages.

data.status

string

obligatoire

Operational state of the business account.

Possible values: pending, active, suspended, disconnected

data.status_reason

string

Reason for the current operational suspension, when recorded. Review feedback is retained on the submission. May contain basic Markdown, such as emphasis and lists.

data.invitations_enabled

boolean

obligatoire

Whether Apple has granted invitation access. Sending also requires a configured, connected account and eligible recipient.

data.created_at

string

obligatoire

When the business record was created.

data.updated_at

string

obligatoire

When the business record was last changed.

data.next

array of object

Next setup actions on create, update and single-account reads. Active accounts return an empty array. Lists omit this field.

Afficher les attributs enfants

data.account_review_status

string

Latest recorded review outcome. Absent before the first submission.

Possible values (may grow over time): pending, approved, rejected

data.finish_setup_url

string

Bird dashboard URL for completing setup. Present only when customer action is available.

next_cursor

nullable string

obligatoire

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor

nullable string

obligatoire

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor

nullable string

obligatoire

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

total

nullable integer

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation

const result = await bird.amb.businessAccounts.list({ limit: 2 });
console.log(result);

result = client.amb.business_accounts.list(limit=2)
print(result)

for item, err := range client.Amb.BusinessAccounts.List(ctx, bird.AmbBusinessAccountsListParams{Limit: 2}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(item)
}

foreach ($bird->amb->businessAccounts->list(['limit' => '2']) as $item) {
    var_dump($item);
}

bird amb business-accounts list

curl -X GET "https://us1.platform.bird.com/v1/amb/business-accounts" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=created_at" \
  --url-query "order=desc" \
  --url-query "limit=25" \
  --url-query "include_total=false"

Réponse200

{
  "data": [
    {
      "id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "apple_business_id": "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
      "name": "Acme Retail",
      "status": "active",
      "invitations_enabled": false,
      "created_at": "2026-08-20T09:14:52Z",
      "updated_at": "2026-08-25T16:42:01Z",
      "next": [
        {
          "kind": "operation"
        }
      ],
      "account_review_status": "approved"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

List Apple Messages for Business records

Paramètres de requête

Contenu de la réponse

Ressources associées