Skip to content
Developers
Open app

List a view's rows

GET
/v1/boards/{id}/views/{viewId}/rows
const url = 'https://api.focal.inc/v1/boards/24ce3d43-516c-4375-9d51-e9a2c8333683/views/a8d4d188-91cb-429f-9fa9-b6b20b43600f/rows';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}

List the board’s rows as seen through a view: only rows matching the view’s filters are returned, each row’s fields are projected to the view’s visible columns (visible_column_ids), and rows are ordered by the view’s own sort.

The shape of each row is identical to GET /v1/boards/{id}/rows — see that endpoint for the fields contract. The difference is membership, column projection, and ordering, all driven by the view.

Because the view’s filters and ordering are evaluated server-side over the whole board, this feed paginates by an opaque offset cursor rather than the (created_at, id) keyset the other list endpoints use; treat next_cursor as opaque and pass it straight back.

Returns 404 when the board or view doesn’t exist, belongs to another organization, is archived, or sits outside the token’s space allow-list.

On a wide board the columns parameter narrows each row’s fields array to the columns you name (by id or name); it intersects with the view’s own visible column set.

Pass fields to trim the response to the properties you actually need — e.g. ?fields=name,html_url returns just those (plus id, always). Unknown names are rejected rather than ignored.

Required scope: boards:read. Rate-limit cost: 5.

id
required
string format: uuid

Example

24ce3d43-516c-4375-9d51-e9a2c8333683
viewId
required
string format: uuid

Example

a8d4d188-91cb-429f-9fa9-b6b20b43600f
limit
integer
>= 1 <= 100

Max rows per page (1–100). Default 25.

cursor
string

Pagination cursor returned as next_cursor from the previous page.

fields
string

Return only these properties of each row, instead of the full object. id is always included. Omit for the complete object. Selectable: id, board_id, parent_id, title, position, fields, organization_id, space_id, archived, created_at, updated_at, html_url.

columns
string

Return only these columns in each row’s fields, instead of every column on the board. Accepts column ids or names (case-insensitive); an entry matching no column is rejected. fields come back in the order listed here; omit for every column, in the board’s own column order. Passing this keeps each row’s fields array even when the fields parameter omits it — selecting columns is asking for cells. Comma-separated.

OK

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string format: uuid
board_id
required
string format: uuid
parent_id
required

Parent row id when this row is nested under another row; null for top-level rows.

string format: uuid
nullable
title
required

Convenience hoist of the title column’s value (the row’s display name). The same value also appears as a fields entry.

string
nullable
position
required

Row’s sort position within its board, lower values render first. Hoisted from the internal order field so clients can sort without an extra /columns call. May be fractional.

number
nullable
fields
required

Self-describing column values for this row — one entry per column, in the column’s display order. A multi-value column carries an array value; a single-value column a scalar. A column with no stored value is still listed, with an empty value ([] / null); archived columns and orphan storage keys are omitted.

Array<object>
object
column_id
required

Stable UUID of the column this value belongs to. Match against Column.id from GET /v1/boards/{id}/columns.

string format: uuid
column_name
required

Human-readable column label, mirrors what users see in the UI.

string
type
required

The kind of column this value belongs to. Combined with multiple, tells you the JSON type of value (for a multi-value column it’s the type of each array element):

  • number / rating → JSON number
  • checkbox → JSON true / false
  • date / updatedat → ISO 8601 string
  • tags / user / media / relation / list → JSON string
  • richtext → Markdown string
  • mediacolumn → the referenced media attribute’s type (e.g. a user attribute stores user id strings)
  • checklist / insights / metricsdata / externaldata / mediaattribute → JSON object
  • everything else → JSON string
string
Allowed values: text media number tags checkbox user date color link rating richtext updatedat createdat relation mediacolumn externaldata creativeid checklist list insights mediaattribute metricsdata
multiple
required

Whether this column holds multiple values. When true, value is an array (one element per stored value); when false, value is a single scalar. For mediacolumn columns this reflects the referenced media attribute’s own setting.

boolean
value
required
Any of:
Array
Any of:
string
display_value
required
Any of:
string
organization_id
required
string format: uuid
space_id
required
string format: uuid
archived
required

true when the row has been archived. List endpoints exclude archived rows by default, so this is always false for rows returned by GET /v1/boards/{id}/rows. Kept on the schema so clients know the field exists.

boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time
html_url
required

Browser URL that opens this row as a detail panel over its board in the Focal web app. Hand this to users as a clickable link to the exact row.

string
next_cursor
required

Pass back as cursor to fetch the next page. null on the last page.

string
nullable
has_more
required

true when another page is available. Equivalent to next_cursor !== null.

boolean

Example

{
"data": [
{
"id": "6eee0a1d-ef35-45ee-b1c9-b95f1f54d652",
"board_id": "24ce3d43-516c-4375-9d51-e9a2c8333683",
"parent_id": "5d1a7c34-9b2e-4f60-8a15-2c7e90b1d4f8",
"title": "Hero video – 4:5 cut",
"position": 2,
"fields": [
{
"column_id": "3298a55a-c00c-4438-9a92-661ae534c8a3",
"column_name": "Status",
"type": "text",
"multiple": false,
"value": "In review",
"display_value": "In review"
},
{
"column_id": "c6873aab-85de-4200-9afc-43470b21cf4c",
"column_name": "Channel",
"type": "tags",
"multiple": true,
"value": [
"9dc9bc29-97d0-48d0-afec-fdbc728d246d",
"b2e7f6a1-3c48-4d95-a0e1-7f5c9d2b8a64"
],
"display_value": [
"Meta",
"TikTok"
]
},
{
"column_id": "993784a7-2dfc-4c80-b52b-0601abf0b58f",
"column_name": "Launch date",
"type": "date",
"multiple": false,
"value": "2027-03-15",
"display_value": "2027-03-15"
}
],
"organization_id": "b46d9033-24b2-4441-87ad-2151088fde01",
"space_id": "6916bc3d-e1ab-425b-ac25-eefada01a9a2",
"archived": false,
"created_at": "2027-03-04T10:15:00Z",
"updated_at": "2027-03-06T14:42:00Z",
"html_url": "https://app.focal.inc/spaces/6916bc3d-e1ab-425b-ac25-eefada01a9a2/boards/24ce3d43-516c-4375-9d51-e9a2c8333683?panel=row_6eee0a1d-ef35-45ee-b1c9-b95f1f54d652"
}
],
"next_cursor": "eyJ0IjoiMjAyNy0wMy0wNFQxMDoxNTowMC4wMDBaIiwiaSI6Ijc4NmJlZWRhLTU1YWMtNDAyNS1iZjZlLTQzYjI5MThlODRhOSJ9",
"has_more": true
}

The request was malformed (invalid cursor, unknown type, validation failure, etc.). error.code is bad_request.

Media typeapplication/json

Canonical error envelope. code is stable across releases and intended for programmatic handling; message is human-readable. details only appears for validation failures and lists the offending fields.

object
error
required
object
code
required
string
Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error
message
required
string
details
Array<object>
object
field
string
issue
required
string

Example

{
"error": {
"code": "bad_request",
"message": "Invalid request body",
"details": [
{
"field": "space_id",
"issue": "Invalid UUID"
}
]
}
}

Missing, invalid, or disabled token. error.code is unauthenticated.

Media typeapplication/json

Canonical error envelope. code is stable across releases and intended for programmatic handling; message is human-readable. details only appears for validation failures and lists the offending fields.

object
error
required
object
code
required
string
Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error
message
required
string
details
Array<object>
object
field
string
issue
required
string

Example

{
"error": {
"code": "unauthenticated",
"message": "Bearer token is missing or invalid"
}
}

The token doesn’t have the scope this endpoint requires. error.code is forbidden.

Media typeapplication/json

Canonical error envelope. code is stable across releases and intended for programmatic handling; message is human-readable. details only appears for validation failures and lists the offending fields.

object
error
required
object
code
required
string
Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error
message
required
string
details
Array<object>
object
field
string
issue
required
string

Example

{
"error": {
"code": "forbidden",
"message": "Token doesn't have the required scope"
}
}

Resource doesn’t exist or is outside the token’s space allow-list. The two cases share a response shape so a restricted token can’t probe for the existence of out-of-scope spaces. error.code is not_found.

Media typeapplication/json

Canonical error envelope. code is stable across releases and intended for programmatic handling; message is human-readable. details only appears for validation failures and lists the offending fields.

object
error
required
object
code
required
string
Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error
message
required
string
details
Array<object>
object
field
string
issue
required
string

Example

{
"error": {
"code": "not_found",
"message": "Not found"
}
}

Rate limit exceeded. error.code is rate_limited. Wait the number of seconds in the Retry-After header before retrying. Quotas are per-token; see the “Rate limiting” section at the top of this document.

Media typeapplication/json

Canonical error envelope. code is stable across releases and intended for programmatic handling; message is human-readable. details only appears for validation failures and lists the offending fields.

object
error
required
object
code
required
string
Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error
message
required
string
details
Array<object>
object
field
string
issue
required
string

Example

{
"error": {
"code": "rate_limited",
"message": "Rate limit of 1000 units per 60s exceeded (this request cost 5)"
}
}
Retry-After
integer
Example
12

Seconds to wait before retrying.