List Rows
stackby.list_rows
ActionDatabases & warehousesconnection required
Calls the Stackby API with the connection's credentials.
Fetch rows from a table, with an optional Stackby filter expression, sort, view and page window.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Stackby
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- base_url, stack_id, table
- Resolved by
- config.connection_id, else node.connection_id
Configuration
10 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 |
|---|---|---|---|---|---|
stack_id Id of the stack to act on, from the stack's URL. Overrides the default stack id on the connection. | string | No | — | — | stqYn5AvM8wJP1pfjw |
table Name or id of the table to act on. Overrides the default table on the connection. | string | No | — | — | tbmtIz6IUXZ1ogNJeB |
view Name of a view whose own filters, sorts and visible columns should apply as well. Leave empty to read the whole table. | string | No | — | — | Grid view |
filter Stackby filter expression, e.g. toContains({Name},Acme). Leave empty to match every row. | string | No | — | — | toContains({Name},Acme) |
sort_field Column name to sort the rows by. Leave empty for Stackby's own order. | string | No | — | — | Name |
sort_direction Direction to sort in; only used when a sort column is named. | string | Conditional | asc | one of "asc", "desc"; only with sort_field | — |
page_size How many rows to return in this page. Stackby defaults to 100. | number | No | — | 1–100 | — |
offset How many rows to skip before this page starts. | number | No | — | ≥ 0 | — |
max_records Hard ceiling on how many rows the request returns; Stackby caps it at 100. | number | No | — | 1–100 | — |
latest Return the rows sorted by the most recent change first. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"filter": "toContains({Name},Acme)",
"latest": false,
"sort_direction": "asc",
"sort_field": "Name",
"stack_id": "stqYn5AvM8wJP1pfjw",
"table": "tbmtIz6IUXZ1ogNJeB",
"view": "Grid view"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
rows The rows Stackby returned, each as {id, field}. | array | — |
count How many rows this response carried. | number | — |
stack_id The stack the rows belong to. | string | — |
table The table the rows belong to. | string | — |
{
"count": 0,
"rows": [],
"stack_id": "",
"table": ""
}Related Stackby nodes
See List Rows run in a workflow.
In a technical demo we add the Stackby connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.