---
title: "Query Object Board Records"
method: POST
path: "/objects/{object_slug}/views/board/records"
tags: ["Objects"]
---

# Query Object Board Records

`POST /objects/{object_slug}/views/board/records`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/objects/{object_slug}/views/board/records`
- Auth: HTTP bearer

Read a bounded status page with current record revisions. This POST performs no writes.

## Path parameters

- `object_slug` string, required

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ObjectBoardPage
  - `state` ObjectViewState, required
    - `version` 1
    - `layout` 'table' | 'board'
    - `filters` RecordFilter[]
      - `attribute_slug` string, required
      - `operator` 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'starts_with' | 'in' | 'is_null' | 'is_not_null', required
      - `value` unknown
    - `search` string
    - `sortBy` string, nullable
    - `sortOrder` 'asc' | 'desc'
    - `includeArchived` boolean
    - `columns` string[], nullable
    - `groupBy` string, nullable
  - `group_value` string, nullable
  - `offset` integer
  - `limit` integer

## Response `200`

Successful Response

- ApiResponseRecordListResponse
  - `data` RecordListResponse, required: Response for listing records.
    - `records` RecordResponse[], required
      - `id` string, uuid, required
      - `object_definition_id` string, uuid, required
      - `organization_id` string, required
      - `is_archived` boolean, required
      - `revision` integer
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `values` object, required
    - `total` integer, required
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)