Read a window of records by position

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

GET/v1/tables/{tableId}/records/window

Request

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

import json
import requests

url = "https://your-suite.grid82.app/your-app/v1/tables/<tableId>/records/window"
headers = {
  "Authorization": "Bearer <token>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://your-suite.grid82.app/your-app/v1/tables/<tableId>/records/window", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://your-suite.grid82.app/your-app/v1/tables/<tableId>/records/window");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://your-suite.grid82.app/your-app/v1/tables/<tableId>/records/window", nil)
  req.Header.Set("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://your-suite.grid82.app/your-app/v1/tables/<tableId>/records/window"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://your-suite.grid82.app/your-app/v1/tables/<tableId>/records/window")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

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

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

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`.

Response

application/json

Success

dataobjectrequired

Show child attributes

data.recordsRecord<string, object>[]required

data.totalintegerrequired

data.offsetintegerrequired

data.fieldsRecord<string, string>required

Read a window of records by position

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown