List Records
nocodb.list_records
ActionDatabases & warehousesconnection required
Calls the NocoDB API with the connection's credentials.
Fetch one page of records from a table, with an optional filter expression, sort, field list and view.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- NocoDB
- Secret shape
- the API token, or {"api_token": "…"}
- Config it needs
- base_url, base_id, table_id, workspace_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
table_id Id of the table to act on, from Table context menu → Copy table ID. Overrides the default table id on the connection. | string | No | — | — | mftbsyu6dxo4y8i |
where NocoDB filter expression, e.g. (Status,eq,todo)~and(Amount,gt,100). Leave empty to match every record. | string | No | — | — | (Status,eq,todo) |
sort Comma-separated fields to sort by; prefix one with '-' for descending order. | string | No | — | — | -CreatedAt |
fields Comma-separated field names to return, with no spaces. Empty returns every field. | string | No | — | — | Id,Title,Status |
limit How many records to return in this page. NocoDB defaults to 25 when unset. | number | No | — | 1–1000 | — |
offset How many matching records to skip before this page starts. | number | No | — | ≥ 0 | — |
view_id Id of a view whose own filters, sorts and visible fields should apply as well. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"fields": "Id,Title,Status",
"sort": "-CreatedAt",
"table_id": "mftbsyu6dxo4y8i",
"where": "(Status,eq,todo)"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, in NocoDB's order. | array | — |
count How many records this page returned. | number | — |
total How many records match in total, when NocoDB reported it. | number | — |
page The page number NocoDB reported for this response. | number | — |
page_size How many records per page NocoDB used. | number | — |
has_more False on the last page; null when NocoDB did not say. | boolean | — |
page_info NocoDB's own pageInfo object, verbatim. | object | — |
table_id The table the records came from. | string | — |
{
"count": 0,
"has_more": false,
"items": [],
"page": 0,
"page_info": {},
"page_size": 0,
"table_id": "",
"total": 0
}See List Records run in a workflow.
In a technical demo we add the NocoDB connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.