Run Report
quickbase.run_report
ActionDatabases & warehousesconnection required
Calls the Quickbase API with the connection's credentials.
Run a saved report and return the records it produces.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Quickbase
- Secret shape
- the Quickbase user token, or {"user_token": "…"}
- Config it needs
- realm_hostname, app_id, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 2 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 |
|---|---|---|---|---|---|
report_id The report to run, as the id quickbase.list_reports returns. | string | Yes | — | — | 1 |
table_id The table to act on, as the table id (dbid) in its URL. | string | Yes | — | — | bck7gp3q2 |
skip How many records to skip before the first one returned; 0 starts at the beginning. | number | No | 0 | ≥ 0 | — |
top Maximum number of records to return; 0 lets Quickbase use its own page size. | number | No | 0 | ≥ 0 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"report_id": "1",
"skip": 0,
"table_id": "bck7gp3q2",
"top": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
data One object per record, keyed by field id, each cell an object with a 'value'. | array | — |
fields One entry per returned column: its id, label and type. | array | — |
metadata Quickbase's paging block: totalRecords, numRecords, numFields and skip. | object | — |
count How many records this response carried. | number | — |
table_id The table the call read. | string | — |
report_id The report that was run. | string | — |
{
"count": 0,
"data": [],
"fields": [],
"metadata": {},
"report_id": "",
"table_id": ""
}See Run Report run in a workflow.
In a technical demo we add the Quickbase connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.