/v1/boardsList the custom boards
Every board the person may see — a table with its own columns and rows — with its access and view. rows=false answers each board's SHAPE: its columns with rows: [] and rowCount, how many rows the person may see — send it unless you need every row of every board, which is seconds on a deep workspace. summary=true answers those shapes smallest, each column as its id, label, kind and optionLabels. A board is found by its name in this list — its rows need not mention it. Each board carries its definitionKey (board-): a board is one door, so its records are read and worked through the definitions tools by that key, as a page's are by its own. The record pages (leads, deals…) are get_definitions; for every board and page, read both.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
"false" · "true"
Responses
the action's answer
{
"data": [
{
"access": "string",
"canShare": true,
"columns": [
{
"calculation": "string",
"config": {
"bands": [
{
"tone": "string",
"upTo": 1.5
}
],
"definitionKey": "string",
"object": "string"
},
"id": "",
"kind": "string",
"label": "string",
"options": [
{
"groupLabel": "string",
"id": "",
"label": "string",
"position": 1.5,
"tone": "string",
"value": "string"
}
],
"position": 1.5,
"starred": true
}
],
"createdAt": "2026-01-01T00:00:00Z",
"definitionKey": "string",
"id": "",
"name": "string",
"purpose": "string",
"recordTabs": "string",
"rowCount": 1,
"rows": [
{
"cells": {},
"createdBy": "string",
"id": "",
"position": 1.5
}
],
"updatedAt": "2026-01-01T00:00:00Z",
"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"
}