---
title: "Read a window of records by position"
description: "Rows `offset` to `offset + limit` of the set a list would return, in the same order, with the size of the whole set."
canonical: "https://grid82.com/docs/app-api/records/window"
updated: "2026-11-13"
---

# Read a window of records by position

`GET https://your-suite.grid82.app/your-app/v1/tables/{tableId}/records/window`

Rows `offset` to `offset + limit` of the set a list would return, in the same order, with the size of the whole set.

> **Note: Generic contract**
>
> Your own version of this operation, with your tables and the fields you can read, is in
> your app's document: `https://{suite}.grid82.app/{app}/v1/openapi.json`, behind your credential.
> [Why each person gets their own](/docs/start/studio-and-runtime#why-an-app-has-an-api-of-its-own).

Meant for a grid that scrolls; to walk a table use records.list and its cursor, which cannot skip or repeat a row when somebody writes in between.

Requires the `records:read` scope. Operation `records.window`. Not an MCP tool. A positional read for a grid that scrolls: it addresses rows by offset, which can skip or repeat a row when somebody writes between two calls. A model walks a table with records.list and its cursor, which cannot, and asks records.count for the size. CLI: `grid82 records window` (`npx grid82`).

## Path parameters

| Name      | Type   | Required | Description |
| --------- | ------ | -------- | ----------- |
| `tableId` | string | yes      |             |

## Query parameters

| Name     | Type    | Required | Description            |
| -------- | ------- | -------- | ---------------------- |
| `viewId` | string  | no       | Up to 64 characters.   |
| `search` | string  | no       | Up to 200 characters.  |
| `filter` | string  | no       | Up to 4000 characters. |
| `sorts`  | string  | no       | Up to 1000 characters. |
| `where`  | string  | no       | Up to 4000 characters. |
| `offset` | integer | no       | Default `0`.           |
| `limit`  | integer | no       | Default `100`.         |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`object`, required)
- `data.records` (`Record<string, object>[]`, required)
- `data.total` (`integer`, required)
- `data.offset` (`integer`, required)
- `data.fields` (`Record<string, string>`, required)

```json
{
  "data": {
    "records": [
      {}
    ],
    "total": 123,
    "offset": 123,
    "fields": {}
  }
}
```

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

```json
{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}
```

**Example request**

```bash
curl --request GET \
  --url 'https://your-suite.grid82.app/your-app/v1/tables/<tableId>/records/window' \
  --header 'Authorization: Bearer <token>'
```
