Get an Apple Messages for Business record

GET

/v1/amb/business-accounts/{business_account_id}

const result = await bird.amb.businessAccounts.get(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(result);

result = client.amb.business_accounts.get('abz_01krdgeqcxet5s7t44vh8rt9mg')
print(result)

result, err := client.Amb.BusinessAccounts.Get(ctx, "abz_01krdgeqcxet5s7t44vh8rt9mg")
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

$bird->amb->businessAccounts->get('abz_01krdgeqcxet5s7t44vh8rt9mg');

bird amb business-accounts get <business-account-id>

curl -X GET "https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}" \
  -H "Authorization: Bearer $TOKEN"

Odpowiedź200

{
  "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"
}

Returns your workspace's Apple Messages for Business record, including its current status with Apple.

Parametry

business_account_id

string

Bird business account ID (abz_) or Apple business UUID. Both resolve within the current workspace.

Treść odpowiedzi

string

wymagane

Unique identifier for the business record.

apple_business_id

nullable string

wymagane

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

name

string

wymagane

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

status

string

wymagane

Operational state of the business account.

Possible values: pending, active, suspended, disconnected

status_reason

string

Reason for the current operational suspension, when recorded. Review feedback is retained on the submission.

invitations_enabled

boolean

wymagane

Whether Apple has granted invitation access. Sending also requires an active account and eligible recipient.

created_at

string

wymagane

When the business record was created.

updated_at

string

wymagane

When the business record was last changed.

array of object

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

Pokaż atrybuty podrzędne

next.kind

string

wymagane

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

next.description

string

wymagane

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

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.

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.

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.

account_review_status

string

Latest recorded review outcome. Absent before the first submission.

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

finish_setup_url

string

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

Powiązane zasoby

Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.

Zrozum koncepcjęShould I use a Bird SDK or call the API directly?Podążaj ścieżką naukiBuild your first integration Przewodnik wdrożeniowySend your first email

Uzyskaj brief wdrożeniowy

const result = await bird.amb.businessAccounts.get(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(result);

result = client.amb.business_accounts.get('abz_01krdgeqcxet5s7t44vh8rt9mg')
print(result)

result, err := client.Amb.BusinessAccounts.Get(ctx, "abz_01krdgeqcxet5s7t44vh8rt9mg")
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

$bird->amb->businessAccounts->get('abz_01krdgeqcxet5s7t44vh8rt9mg');

bird amb business-accounts get <business-account-id>

curl -X GET "https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}" \
  -H "Authorization: Bearer $TOKEN"

Odpowiedź200

{
  "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"
}