GET
/v1/ingest/boardRead the board
The board's columns, a page of its rows, and write — exactly what POST /v1/ingest/rows takes on this board. Scope read.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokenboardKeyoptional
Stored only in this browser for the boardKey security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
limitquery · integeroptional
Rows per page.
cursorquery · stringoptional
The nextCursor from the previous page. Opaque.
rowsquery · booleanoptional
false answers the shape and the write guide only.
Responses
200application/json
The board.
{
"data": {
"object": "string",
"columns": [
{
"id": "",
"label": "string",
"kind": "string",
"askedFirst": true,
"writable": true,
"why": "string",
"format": "string",
"options": [
{
"value": "string",
"label": "string"
}
],
"members": [
{
"id": "",
"name": "string",
"email": "string"
}
],
"example": "string"
}
],
"rows": [
{
"id": "",
"position": 1,
"source": "string",
"cells": {},
"createdBy": "string"
}
],
"write": {
"method": "string",
"path": "string",
"columns": [
{
"id": "",
"label": "string",
"kind": "string",
"askedFirst": true,
"writable": true,
"why": "string",
"format": "string",
"options": [
{
"value": "string",
"label": "string"
}
],
"members": [
{
"id": "",
"name": "string",
"email": "string"
}
],
"example": "string"
}
],
"example": {
"cells": {},
"external_id": ""
}
},
"total": 1,
"nextCursor": "string"
}
}dataoptional
401application/json
No key, or an unknown or revoked one.
{
"error": {
"message": "string",
"errors": [
{
"index": 1,
"message": "string"
}
]
}
}errorrequired
403application/json
The key was not given read.
{
"error": {
"message": "string",
"errors": [
{
"index": 1,
"message": "string"
}
]
}
}errorrequired
429application/json
Over 120 requests a minute; wait Retry-After seconds.
{
"error": {
"message": "string",
"errors": [
{
"index": 1,
"message": "string"
}
]
}
}errorrequired