/v1/boards/{id}Read one board, whole
One custom board by id: its columns (each select column's choices with them), the layout it opens in, how far the CALLER may go on it, and EVERY ROW on it — unpaged, cells keyed by column id. A deep board is a deep answer: reach for it when you need the board's SHAPE, for get_boards_id_rows when you want a page of its rows narrowed by a search, ticked values or a sort, and for get_search when you only want to find one record by name. A pack page (leads, deals, contacts) is get_definitions_key for the shape and get_definitions_key_rows for one page of its rows.
Access class: board:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": {
"access": "string",
"columns": [
{
"calculation": "string",
"config": {},
"id": "",
"kind": "string",
"label": "string",
"options": [
{
"groupLabel": "string",
"id": "",
"label": "string",
"position": 1.5,
"tone": "string",
"value": "string"
}
],
"position": 1.5,
"starred": true
}
],
"createdAt": "string",
"definitionKey": "string",
"id": "",
"name": "string",
"purpose": "string",
"rows": [
{
"cells": {
"<uuid-2>": "string"
},
"createdBy": "string",
"id": "",
"position": 1.5
}
],
"updatedAt": "string",
"view": "string"
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}