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

# Call widget.list

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

## Request

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

Read the widgets on every desk and project in one call — 'what's on my desks?', 'which charts are on the Client project?', 'how many leads did we get yesterday?' — each widget, what it shows, every desk or project it is placed on and what that placement reads, the Dashboard's desks (its tabs), and the figures across the top of the Dashboard as the card shows them: yesterday's leads against their recent daily average, pieces shipped this week and pieces booked for next week. Leads are counted per day, so a question about yesterday's leads is answered from these figures. Call it first before changing, trashing, placing or binding a widget: the other verbs need its id, and the member names widgets the way they see them ('the ad-spend chart'). Narrow it to one desk by its name, or one desk or project by an id this call or the page gave you, or read the widgets in the Trash. It changes nothing. Not for making a widget — that is `widget.add`; not for the week's story — that is `briefing.read`; not for the numbers a chart shows — that is `analytics.query_metrics` with the chart's metric_keys.

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
  - `board_id` string, uuid: Only the widgets on this project (not a desk), by its id from `board.tree`.
  - `in_trash` boolean: True to read the widgets in the Trash instead — the ones trashed in the last 30 days, which `item.restore` brings back.
  - `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
    - `figures` object, nullable, required
      - `leads_counted_per` 'day', required
      - `leads_day` string, required
      - `lines` object[], required
        - `label` string, required
        - `figure` string, required
        - `change` string, nullable, required
        - `detail` string, required
    - `dashboard` object, nullable, required
      - `board_id` string, required
      - `desks` object[], required
        - `board_id` string, required
        - `name` string, required
    - `widgets` object[], required
    - `truncated` boolean, required
    - `answer_note` string, 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/6d82fb124064?raw)