---
title: "Read the deals board"
method: GET
path: "/api/v1/rest/crm/board"
tags: ["CRM"]
---

# Read the deals board

`GET /api/v1/rest/crm/board`

## Request

- Base URL: `https://api.custodo.ai`
- URL: `https://api.custodo.ai/api/v1/rest/crm/board`
- Auth: HTTP bearer

The sales pipeline as a board: the pipeline, its live stages in order, and a page of open deals per stage. Each column also reports its WHOLE population and total value under the same filters, so read those totals and never the length of the card list — a column showing ten of ninety is what makes a board useless as a forecast. Only OPEN deals appear and archived stages are excluded; for what has already closed, or for any filter this does not offer, call crm_list_deals.

**Examples**

- What does the pipeline look like right now?
  `GET /api/v1/rest/crm/board`
- Show me just Laura’s board, five cards a column
  `GET /api/v1/rest/crm/board?owner_user_id=55555555-6666-4777-8888-999999999999&per_stage=5`

## Query parameters

- `pipeline_id` string, uuid
- `owner_user_id` string, uuid
- `query` string
- `per_stage` integer
- `response_format` 'concise' | 'detailed'

## Headers

- `X-Tenant-Id` string, uuid

## Response `200`

Done. `data` is the tool’s own answer.

- RestResult
  - `ok` true, required
  - `data` unknown, required

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)