List Apple Messages for Business records

GET

/v1/amb/businesses

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

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

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

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

bird amb businesses list

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

Respuesta200

{
  "data": [
    {
      "id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "apple_business_id": "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
      "display_name": "Acme Retail",
      "status": "approved",
      "status_reason": null,
      "msp_app": "eu1",
      "invitations_enabled": false,
      "created_at": "2026-08-20T09:14:52Z",
      "updated_at": "2026-08-25T16:42:01Z",
      "next": [
        {
          "kind": "operation"
        }
      ]
    }
  ],
  "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.

Parámetros de consulta

sort

string

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

Possible values: created_at

order

string

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

limit

integer

Maximum number of items to return per page.

starting_after

string

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

ending_before

string

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

boolean

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

Carga de respuesta

data

array of object

obligatorio

The business records your workspace holds.

Mostrar atributos secundarios

data.id

string

obligatorio

Unique identifier for the business record.

data.apple_business_id

nullable string

obligatorio

The Apple Business ID stored for this brand. Null until supplied. New values must be UUIDs; legacy records can contain a non-UUID identifier until corrected. Supplying or correcting the identifier leaves the status unchanged; an evidence submission moves the record to submitted.

data.display_name

string

obligatorio

The brand name shown for this business record inside Bird. This is not the name Apple shows to customers; that name comes from the Apple Business Register account behind the Business ID.

data.status

string

obligatorio

Where the business record stands with Apple.

Possible values: draft, submitted, in_review, approved, rejected, suspended

data.status_reason

nullable string

obligatorio

Free-text detail behind status, such as why Apple's review ended in rejected. Null when Bird has recorded no detail for the current status.

data.msp_app

string

obligatorio

The regional Messaging Service Provider application this business is registered under.

Possible values: eu1, us1

data.invitations_enabled

boolean

obligatorio

Whether this business can send invitations. Apple grants invitation access separately from approving the business itself, so this can be false on an approved business.

data.created_at

string

obligatorio

When the business record was created.

data.updated_at

string

obligatorio

When the business record was last changed.

data.next

array of object

Onboarding actions computed from the business status and Apple Business ID. Present on create, update and single-business reads; omitted on lists. Approved businesses have no onboarding action. Evidence readiness is not inferred from this record; prepare and upload the required files before submission.

Mostrar atributos secundarios

data.next.kind

string

obligatorio

What you do about this step.

operation: call the operation named in operation, then read again.
external: act somewhere this API does not reach, then read again.
wait: nothing is asked of you, so read again later.
terminal: nothing you do resolves this, so stop retrying.

Tolerate a value you do not recognize: show the description and offer no action.

Possible values (may grow over time): operation, external, wait, terminal

data.next.description

string

obligatorio

A short, human-readable label for the step, suitable for display.

data.next.operation

string

The operationId to call. Present only when kind is operation. The operation's own schema says how to call it; this says only which one, and what to address it with.

data.next.params

object

The parameters that address the operation, by name: {"sender_id": "…"} for an operation on /v1/sms/senders/{sender_id}/requirements. A parameter the operation takes in its query string is given the same way, so an operation addressed as ?subject_id= carries {"subject_id": "…"}. Every parameter the call needs is here, whether its value came from the thing you were acting on or is fixed for this step, so you can make the call from this object alone. Present only when kind is operation and the operation names a subject. A request body, when the operation takes one, is described by the operation's own schema and never appears here.

data.next.url

string

A URL to open. Present only when kind is external, and only when the step has one. An external step whose description says to go and do something with no URL to open is normal.

next_cursor

nullable string

obligatorio

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

prev_cursor

nullable string

obligatorio

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

refresh_cursor

nullable string

obligatorio

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.

Recursos relacionados

Continúa con la documentación, guías y ejemplos sobre este tema. Los recursos están en inglés.

Comprender el conceptoShould I use a Bird SDK or call the API directly?Seguir la ruta de aprendizajeBuild your first integration Guía de implementaciónSend your first email

Obtener un resumen de implementación

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

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

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

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

bird amb businesses list

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

Respuesta200

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