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

# Get agent setup status

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

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/accounts/{accountId}/business-agent`
- Auth: HTTP bearer

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.


**Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min

## Path parameters

- `accountId` string, required: WhatsApp social account id (the number must be managed through the Cloud API).

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Where the merchant is in the Meta Business Agent setup for this number.
    - `agentId` string, nullable, required
    - `enabled` boolean, required: The agent answers live conversations.
    - `eligible` boolean, nullable, required: Whether the number can run the agent; null when the terms are not accepted yet (Meta refuses the check).
    - `settings` object, nullable, required: Meta Business Agent settings for one WhatsApp number, as Meta returns them.
      - `channel` string, required
      - `handoff` object, nullable
        - `enabled` boolean: Whether the agent releases the thread after sending its handoff message.
        - `message` string
        - `message_selection` 'DEFAULT' | 'AGENT' | 'CUSTOM'
      - `rollout` object, required
        - `enabled` boolean, required: Whether the agent answers live conversations.
      - `agent_id` string, required
      - `followup` object, nullable
        - `enabled` boolean
        - `message` string
        - `followup_interval_in_seconds` 0 | 300 | 900 | 1800 | 3600 | 7200 | 28800 | 86400
      - `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.
    - `onboarded` boolean, required: An agent exists on the number (onboard was called).
    - `manualSteps` object[], required: Steps Meta keeps outside the API that Zernio can verify are still pending.
      - `url` string, uri, required
      - `step` 'accept_terms', required
      - `description` string, required
    - `termsAccepted` boolean, required: False when Meta rejects calls because the merchant has not accepted the terms in WhatsApp Manager.
    - `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.
      - `url` string, uri, required
      - `step` 'attach_payment_method', required
      - `description` string, required
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)