Query Records

quickbase.query_records

ActionDatabases & warehousesconnection required

Calls the Quickbase API with the connection's credentials.

Read records from a table using the Quickbase query language.

Ask about Quickbase All Quickbase nodes Provider API docs ↗

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

8 fields, 1 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 The table to act on, as the table id (dbid) in its URL.	string	Yes	—	—	bck7gp3q2
select Field ids to return. Leave empty for the table's default columns.	array	No	—	array of number	[1,2,3]
where A Quickbase query-language filter, such as {6.EX.'hello'}. Leave empty to return every record.	string	No	—	—	{6.EX.'hello'}
sort_by Sort order, as objects of 'fieldId' and 'order' (ASC, DESC or equal-values). Leave empty for an unsorted, faster query.	array	No	—	array of object	[{"fieldId":4,"order":"ASC"}]
group_by Grouping, as objects of 'fieldId' and 'grouping'.	array	No	—	array of object	[{"fieldId":6,"grouping":"equal-values"}]
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	—
compare_with_app_local_time Compare date-time fields against the application's local time instead of UTC.	boolean	No	false	—	—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "compare_with_app_local_time": false,
  "group_by": [
    {
      "fieldId": 6,
      "grouping": "equal-values"
    }
  ],
  "select": [
    1,
    2,
    3
  ],
  "skip": 0,
  "sort_by": [
    {
      "fieldId": 4,
      "order": "ASC"
    }
  ],
  "table_id": "bck7gp3q2",
  "top": 0,
  "where": "{6.EX.'hello'}"
}

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	—

{
  "count": 0,
  "data": [],
  "fields": [],
  "metadata": {},
  "table_id": ""
}

Related Quickbase nodes

See Query Records 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.

Book a technical demo Talk to sales