amb-business-accounts

Get an Apple Messages for Business record

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

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

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

business_account_idstring required

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

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The Apple Messages for Business record.

idstring required
apple_business_idstring uuid nullable required

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

namestring required

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

status'pending' | 'active' | 'suspended' | 'disconnected' required

Pending accounts need setup or review. Active accounts have recorded approval. Suspended accounts retain their recorded suspension. Configured, connected accounts can exchange messages regardless of review status; Apple decides whether to accept outgoing requests. Disconnected accounts retain their identity and history but cannot exchange new messages until reconnected.

status_reasonstring

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

invitations_enabledboolean required

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

created_atstring date-time required

When the business record was created.

updated_atstring date-time required

When the business record was last changed.

account_review_statusstring

Latest review outcome recorded by Bird staff.

finish_setup_urlstring uri

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

Example response

{
  "id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "apple_business_id": "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
  "name": "Acme Retail",
  "status": "active",
  "created_at": "2026-08-20T09:14:52Z",
  "updated_at": "2026-08-25T16:42:01Z",
  "account_review_status": "approved"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.