---
title: "List Apple Messages for Business records"
method: GET
path: "/v1/amb/business-accounts"
tags: ["amb-business-accounts"]
---

# List Apple Messages for Business records

`GET /v1/amb/business-accounts`

## Request

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

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

## Query parameters

- `sort` 'created_at': Field used to order the records.
- `order` 'asc' | 'desc': Sort direction, ascending or descending.
- `limit` integer
- `starting_after` string
- `ending_before` string
- `include_total` boolean

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

A page of your workspace's Apple Messages for Business records.

- AMBBusinessAccountList
  - `data` AMBBusinessAccount[], required: The business records your workspace holds.
    - `id` string, required
    - `apple_business_id` string, uuid, nullable, required: Apple business UUID, or null until supplied. Adding this identifier does not submit the account for review.
    - `name` string, 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_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.
    - `invitations_enabled` boolean, required: Whether Apple has granted invitation access. Sending also requires a configured, connected account and eligible recipient.
    - `created_at` string, date-time, required: When the business record was created.
    - `updated_at` string, date-time, required: When the business record was last changed.
    - `next` NextAction[]: Next setup actions on create, update and single-account reads. Active accounts return an empty array. Lists omit this field.
      - `kind` string, required: 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.
      - `description` string, required: A short, human-readable label for the step, suitable for display.
      - `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.
      - `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.
      - `url` string, uri: 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 review outcome recorded by Bird staff.
    - `finish_setup_url` string, uri: Bird dashboard URL for completing setup. Present only when customer action is available.
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: 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` integer, nullable: Total number of items matching the request's filters across all pages. Present only when `include_total=true` was passed; otherwise `null`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)