Sheets

​
List rows in an in-house sheet tab

Cursor pagination follows stored row order. Default limit 100, maximum 1000. Optional CSV and head/tail sampling apply within the requested page.

GET
/v1/space/sheets/{sheet_id}/tabs/{tab_id}/rows
curl -X GET "https://api.orchestor.io/v1/space/sheets/%3Csheet_id%3E/tabs/%3Ctab_id%3E/rows?limit=100&as=rows&max_rows=1000&sample=head" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123"
{  "csv": "<string>",  "data": [    {      "id": "<string>",      "parentId": "<string>",      "values": {}    }  ],  "has_more": true,  "next_cursor": "<string>",  "omitted_rows": 0,  "total_rows": 0,  "truncated": true,  "updated_at": "2026-01-01T00:00:00Z"}

Get your Orchestor API key

Create an API key in your workspace settings.

Authorizations

Satisfy one of these options:

  • Session cookie
  • API key

Authentication details

cookie
wos-session

Browser session established by signing in to the web app. The server checks your workspace membership and permissions. Supply X-Workspace-ID for workspace-scoped operations. For server-to-server requests, use an API key when the operation supports it.

Path Parameters

sheet_idstringpathrequired
Pattern
^sht_[a-f0-9]{24}$
tab_idstringpathrequired
String length
≥ 1, ≤ 256

Query Parameters

limitintegerquerydefault:100
Value range
≥ 1, ≤ 1000
cursorstringquery
String length
≥ 1, ≤ 256
asstringenum<string>querydefault:rows
Allowed
rowscsv
max_rowsintegerquerydefault:1000
Value range
≥ 1, ≤ 10000
samplestringenum<string>querydefault:head
Allowed
headhead_and_tail

Headers

X-Workspace-IDstringheader

Workspace to access. With a workspace-scoped API key, the server derives this value from the key, so the header is optional. If supplied, it must match the credential workspace or the request returns 403 workspace_mismatch. For interactive session requests, supply this header to select a workspace where you are a member. A project ID cannot be used as a workspace ID.

Example"wks_abc123"

Response

application/json

Rows, next cursor and sheet concurrency token

csvstring | nullrequired
dataobject[]required
data[]object
Additional properties
Not allowed
data[].idstringrequired
String length
≥ 1, ≤ 256
data[].parentIdstring
String length
≥ 1, ≤ 256
data[].valuesobject
data[].values.*string | number | boolean | string[]

Match at least one of the following

Variant 1: string

data[].values.*string

Variant 2: number

data[].values.*number

Variant 3: boolean

data[].values.*boolean

Variant 4: string[]

data[].values.*[]string
has_morebooleanrequired
next_cursorstring | nullrequired
omitted_rowsintegerrequired
total_rowsintegerrequired
truncatedbooleanrequired
updated_atstringrequiredformat:date-time