---
title: "Get agent setup status"
method: GET
path: "/v1/accounts/{accountId}/business-agent"
tags: ["Business Agent"]
---

# Get agent setup status

`GET /v1/accounts/{accountId}/business-agent`

One read that says where the merchant is: whether the number is eligible, whether the
Meta Business Agent terms are accepted, whether an agent exists, whether it is on, and its
settings. `manualSteps` lists what Zernio can verify is still pending (accepting the terms
in WhatsApp Manager); `unverifiedSteps` lists what Meta exposes no state for (the payment
method in Billing Hub). Never fails for those pre-setup states; it reports them as flags.

## Path parameters

- `accountId` string, required

## Response `200`

Setup status

- BusinessAgentStatus — Where the merchant is in the Meta Business Agent setup for this number.
  - `eligible` boolean, nullable, required — Whether the number can run the agent; null when the terms are not accepted yet (Meta refuses the check).
  - `termsAccepted` boolean, required — False when Meta rejects calls because the merchant has not accepted the terms in WhatsApp Manager.
  - `onboarded` boolean, required — An agent exists on the number (onboard was called).
  - `enabled` boolean, required — The agent answers live conversations.
  - `agentId` string, nullable, required
  - `settings` BusinessAgentSettings, required — Meta Business Agent settings for one WhatsApp number, as Meta returns them.
    - `agent_id` string, required
    - `channel` string, required
    - `rollout` object, required
      - `enabled` boolean, required — Whether the agent answers live conversations.
    - `handoff` object, nullable
      - `enabled` boolean — Whether the agent releases the thread after sending its handoff message.
      - `message` string
      - `message_selection` 'DEFAULT' | 'AGENT' | 'CUSTOM'
    - `followup` object, nullable
      - `enabled` boolean
      - `followup_interval_in_seconds` 0 | 300 | 900 | 1800 | 3600 | 7200 | 28800 | 86400
      - `message` string
    - `ai_audience` 'EVERYONE' | 'ALLOWLISTED_ONLY' | 'null', nullable — EVERYONE answers all consumers; ALLOWLISTED_ONLY answers only the allowlist and needs no payment method.
    - `never_say_phrases` string[] — Exact phrases the agent must never say.
  - `manualSteps` object[], required — Steps Meta keeps outside the API that Zernio can verify are still pending.
    - `step` 'accept_terms', required
    - `url` string, uri, required
    - `description` string, required
  - `unverifiedSteps` object[], required — Steps Meta keeps outside the API and exposes no state for, listed once an agent exists. Informational: Zernio cannot tell whether the merchant already did them.
    - `step` 'attach_payment_method', required
    - `url` string, uri, required
    - `description` string, required

## Other responses

- `400` — Invalid request
- `401` — Unauthorized
- `403` — Inbox add-on required, the WhatsApp token lacks the Business Agent permissions (code reconnect_required), or the merchant has not accepted the Meta Business Agent terms in WhatsApp Manager (code business_agent_terms_not_accepted).
- `404` — Account not found, or no agent exists on the number yet or the referenced item does not exist (code business_agent_not_found).

## Changes

- **2026-09-25** `2c04683ce694` — 12 info
  - added the optional property `details/adAccountId` to the response with the `400` status
  - added the optional property `details/adAccountId` to the response with the `403` status
  - added the optional property `details/adAccountId` to the response with the `404` status
  - added the optional property `details/createdObjects` to the response with the `400` status
  - …8 more
- **2026-09-16** `3e6ddf2a99ea` — 3 info
  - added the optional property `details/budgetScope` to the response with the `400` status
  - added the optional property `details/budgetScope` to the response with the `403` status
  - added the optional property `details/budgetScope` to the response with the `404` status
- **2026-09-15** `0dba7d004d75` — 6 info
  - added the optional property `details/quotaExhausted` to the response with the `400` status
  - added the optional property `details/quotaExhausted` to the response with the `403` status
  - added the optional property `details/quotaExhausted` to the response with the `404` status
  - added the optional property `details/quotaScope` to the response with the `400` status
  - …2 more
- **2026-09-09** `41eff0cffb2d` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/zernio/apis/zernio-api/changes/v1/accounts/:accountId/business-agent/get.md)

---

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