Node.js SDK
API Reference
List Table Rows
Get rows from a table, optionally filtered and sorted
GET
Node.js SDK
Overview
Retrieves rows (records) from the specified table. Each row contains values for the table’s columns. You can optionally search, filter, and sort the result with theq, filter, and sort query parameters.
Search
Passq to run a case-insensitive search across searchable table columns. This uses the same indexed table search path as the web grid.
Filtering
Pass a JSON object as thefilter query parameter:
match:"and"(default) or"or"— how to combine multiple conditions.conditions[]: up to 20 conditions. Each hascolumn_id,operator, and (for most operators)value.
Operators by column type
| Column type | Operators |
|---|---|
| string | equals, not_equals, contains, not_contains, starts_with, ends_with, is_empty, is_not_empty |
| number | equals, not_equals, gt, gte, lt, lte, includes, not_includes, is_empty, is_not_empty |
| select (status / dropdown / labels) | equals, not_equals, includes, not_includes, is_empty, is_not_empty |
| bool | equals, not_equals, is_empty, is_not_empty |
| date | equals, before, after, between, today, yesterday, tomorrow, next_7_days, last_7_days, current_week, last_week, next_week, current_month, last_month, next_month, is_empty, is_not_empty |
Value shape
- string operators take a string
value. - number operators take a number
value;includes/not_includestakenumber[]. - select operators take a single string or
string[]of option IDs. - date
equals/before/aftertake an ISO date string;betweentakes a[startISO, endISO]tuple; the relative operators (today,current_week, …) take novalue. is_empty/is_not_emptytake novalue.
Sorting
Pass a comma-separated spec as thesort query parameter:
<columnId>:asc or <columnId>:desc. Sorting by password columns is not allowed.
Response
Returns an array of row objects with:- Row ID and internal rowId number
- Owner and timestamps
- Column values (columnId and value pairs)
Authorizations
Bearer token
Path Parameters
ObjectId
Required string length:
24Pattern:
^[0-9a-fA-F]{24}$ObjectId
Required string length:
24Pattern:
^[0-9a-fA-F]{24}$Query Parameters
Case-insensitive row search across searchable table columns.
Maximum string length:
200JSON filter as a string, e.g. {"match":"and","conditions":[{"column_id":"…","operator":"contains","value":"foo"}]}. See the list-table-rows endpoint docs for the full operator catalog.
Comma-separated sort spec, e.g. "col_a:asc,col_b:desc". Defaults to no sorting.