---
title: "Call page.list"
method: POST
path: "/api/v1/tools/page.list"
tags: ["page"]
---

# Call page.list

`POST /api/v1/tools/page.list`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/page.list`
- Auth: HTTP bearer

List this workspace's customer pages — name, draft/live status, address, last activity and lead count — plus the workspace totals (total_count, live_count, leads_this_month). The reply is ONE PAGE of sites, newest activity first: when it carries next_cursor there are more, so say how many you showed of total_count and pass next_cursor as cursor to read the next page (if the sites changed in between, the cursor is refused: start again from the first page and read the list over rather than joining it to what you have). Pass list 'templates' to read the template catalogue instead — the first-party template ids page.create accepts and every saved template this account can start from, named so you can offer them by name, also one page at a time. That template list is WIDER than this workspace: some were published by other workspaces in the same account and some are ours and shipped to every account — each row says which (`scope`), whether this workspace authored it (`owned_by_this_workspace`), and whether you may withdraw it (`retirable`). Only a row with `retirable: true` can be retired here. Reach for sites when the member asks WHICH sites they have — 'what pages do I have?', 'show me my sites', 'is the pricing page live yet?' — or when they name a site that is NOT the one already open on screen and you need its id; reach for templates only before offering a template by name. Not for one site's own state — that is `page.read` — and not for finding the site already open on their screen: that surface already carries its id, and listing the workspace to rediscover it is the hunt that ends in the wrong id.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one.

## Headers

- `x-request-id` string

## Request body

- object
  - `include_archived` boolean: True to include archived pages. Leave unset for the board's normal view.
  - `list` 'sites' | 'templates': Which list to read. 'sites' (the default) is the workspace's pages. 'templates' is the template catalogue page.create starts from — ask for it only when the member wants to pick or hear about a template; it returns no sites.
  - `limit` integer: How many rows to return — at most 50; omit for 10 sites or 7 templates. The reply is one PAGE: a next_cursor in it says rows remain.
  - `cursor` string: Where to continue: pass the next_cursor from the previous reply, with the same list, include_archived and name. Omit it for the first page. If the list changed since that page, the cursor is refused: start again without it.
  - `name` string: The site's name or address as the member said it ("Spring promo", "spring-promo.example.com"). Returns just that site with its site_id — an exact name or address first, else the one site whose name starts with it. When several fit, the result lists them as candidates: ask the member which one, never pick. Use this whenever a verb needs a site_id for a site they NAMED. Not with list templates — that call is refused.
  - `workspace` string: Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

## Response `200`

The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `sites` object[], required
      - `site_id` string, uuid, required
      - `name` string, required
      - `status` string, required
      - `hostname` string, nullable, required
      - `published_at` string, nullable, required
      - `updated_at` string, required
      - `archived` boolean, required
      - `lead_count` integer, required
    - `list` 'sites' | 'templates'
    - `next_cursor` string
    - `templates_total` integer
    - `total_count` integer, required
    - `live_count` integer, required
    - `leads_this_month` integer, required
    - `template_ids` string[], required
    - `name_match` object
      - `kind` 'exact' | 'prefix' | 'ambiguous' | 'none', required
      - `name` string, required
      - `searched` integer, required
      - `total` integer, required
    - `blueprints` object[], required
      - `blueprint_id` string, required
      - `name` string, required
      - `description` string, required
      - `scope` 'platform' | 'tenant', required
      - `owned_by_this_workspace` boolean, required
      - `retirable` boolean, required
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/0e033701d3f7?raw)