GET
/docs/{docId}/tables/{tableId}/recordsList records from a table
Lists records from a specified table in a document. Use filter to match column values, sort or X-Sort to order results, and limit or X-Limit to cap the number returned. Set cellFormat to typed for self-describing cell values, or set hidden to true to include hidden columns.
docIdstringrequired
The document identifier, as a UUID string.
tableIdstringrequired
The normalized table name or numeric row ID in `_grist_Tables` identifying the table.
filterstringoptional
A JSON object mapping column names to arrays of allowed values; URL-encode the JSON before placing it in the query string.
sortstringoptional
Column names that determine result order, separated by commas for multiple columns. Prefix a column name with `-` for descending order, use `manualSort` for manually prepared order, and append supported options (`orderByChoice`, `naturalSort`, or `emptyLast`) after a colon. Result order is unspecified when omitted.
limitnumberoptional
The maximum number of rows to return. A value of `0` means there is no limit.
hiddenbooleanoptional
Set to `true` to include hidden columns such as `manualSort`.
cellFormatstringoptional
Cell value format: `normal` or `typed`. The typed format returns self-describing values; the normal format uses compact values interpreted according to column type.
X-Sortstringoptional
The sort order to apply, using the same format as the `sort` query parameter.
X-Limitnumberoptional
The maximum number of rows to return, using the same behavior as the `limit` query parameter.
200Returns an object containing a `records` array; each record includes its `id` and `fields`, and may include formula error details.
recordsarray<object>required
Error handling
The docId path parameter is described as a UUID string, and the tableId path parameter must be a normalized table name or numeric row ID in _grist_Tables. Encode the JSON value in filter for safe use in a URL; cellFormat accepts only normal or typed.