Read the deals board
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
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/rest/crm/board
- Auth: HTTP bearer
Query parameters
Which pipeline. Omit for the organisation’s default one.
Only one colleague’s cards. From custodo_whoami for your own.
Full-text over the deal title and the customer. At least two characters.
Cards per column, 1–200. Default 10 — each column also reports its WHOLE population and total value under the same filters, so a small page still gives correct numbers.
concise (default) returns the fields you need to answer a question; detailed adds related records and costs more context.
Headers
The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.
Response
Done. data is the tool’s own answer.
Changes
No recorded changes to this operation across all 1 revision of this API.