---
title: "List crawled websites"
method: GET
path: "/v1/accounts/{accountId}/business-agent/websites"
tags: ["Business Agent"]
---

# List crawled websites

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

## Path parameters

- `accountId` string, required

## Response `200`

Websites

- object
  - `websites` BusinessAgentWebsite[], required
    - `url` string, uri, required
    - `included_sub_domains` string[]
    - `included_url_patterns` string[] — Only URLs containing one of these substrings are ingested.
    - `excluded_sub_domains` string[]
    - `excluded_url_patterns` string[]
    - `single_urls` string[] — Crawl only these exact pages instead of the whole site.
    - `id` string, required
    - `crawl_status` string — not_started, pending, in_progress, completed, completed_no_data or failed (see crawl_error).
    - `crawl_error` string
    - `pages_crawled` integer
    - `last_crawled_at` integer — Unix seconds.
    - `created_at` integer — Unix seconds.

## 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/websites/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)