Connects to Quickbase to work with applications, tables, records and administrative functions through its JSON REST API. Use templates to query data, insert or update records in batches, manage resources and transfer supported documents.
0.0.0.4 - Provides queries, mutations, downloads and explicit credential operations with partial-success reporting.
| Property |
Type |
Description |
RealmHostname |
String |
Realm hostname, for example example.quickbase.com, without a scheme or path. |
UserToken |
Masked |
Permanent user token for the integration identity, assigned to the required applications. |
TestAppId |
String |
Optional application ID used for a read-only Connection test. |
BrowserSessionCookie |
Masked |
Existing authenticated browser-session Cookie header, used only for temporary-token issuance. |
AppToken |
Masked |
Optional application token used for temporary-token issuance. |
- Create a dedicated integration user token and assign it to the required applications.
- Set
RealmHostname and UserToken. The user's application roles must permit the selected operations.
- Set
TestAppId to test access to a known application without requiring realm-wide application-listing permissions.
- Select a Method and template. Use actual table and field IDs from your application.
Select a Method and its template to populate the operation and its supported fields.
Reads data with automatic paging. Read operations that use POST, including record queries and reports, accept a single Filter object.
| Parameter |
Type |
Description |
Connection |
Connection |
Quickbase Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Options |
Object |
Route and query values required by the selected operation. |
Filter |
Object |
Structured request for a POST read, as shown by the selected template. |
| Return |
Type |
Description |
Response |
Array |
Individual Quickbase records. Open-ended record data is returned as JSON text in Response.Value. |
Creates resources, inserts or updates records (upsert), or performs the selected Quickbase action.
| Parameter |
Type |
Description |
Connection |
Connection |
Quickbase Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Items |
Array |
Complete request bodies, one item per Quickbase request. |
Options |
Object |
Route and query values required by the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Quickbase results with Flowgear.IsSuccess, Flowgear.Message, and a copy of the input in Flowgear.Request. |
Updates resources or performs the selected update action.
| Parameter |
Type |
Description |
Connection |
Connection |
Quickbase Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Items |
Array |
Complete request bodies, one item per Quickbase request. |
Options |
Object |
Route and query values required by the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Quickbase results with Flowgear.IsSuccess, Flowgear.Message, and a copy of the input in Flowgear.Request. |
Deletes explicitly selected resources. To delete records, supply a nonempty where expression that identifies the records to delete.
| Parameter |
Type |
Description |
Connection |
Connection |
Quickbase Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Items |
Array |
Complete request bodies, one item per Quickbase request. |
Options |
Object |
Route and query values required by the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Quickbase results with Flowgear.IsSuccess, Flowgear.Message, and a copy of the input in Flowgear.Request. |
Downloads an attachment or generates a supported document.
| Parameter |
Type |
Description |
Connection |
Connection |
Quickbase Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Options |
Object |
Route and query values required by the selected operation. |
| Return |
Type |
Description |
Content |
Stream |
Readable decoded document content. The consumer owns the stream and must dispose it when finished. |
Explicitly issues, exchanges or manages tokens. Credential results are returned directly and must be handled as sensitive data.
| Parameter |
Type |
Description |
Connection |
Connection |
Quickbase Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Options |
Object |
Route and query values required by the selected operation. |
Items |
Object |
One credential-operation body. It is not copied into response metadata. |
Confirm |
Boolean |
Must be explicitly set to true to authorize the operation. Defaults to false, including token deletion. |
| Return |
Type |
Description |
Response |
Object |
Quickbase credential-operation result. The input is not copied into Flowgear.Request. |
- Query and report records contain Quickbase field IDs and their values, returned as JSON text in
Response.Value. For upsert, supply Items.data as JSON array text. The Node does not automatically generate template fields for your table columns.
- Each item supplied to
Create, Update or Delete is a complete Quickbase request body. An empty input stream sends no requests. For an action that has no request body, supply an empty object ({}) in Items.
Options apply to every item in a Node invocation. To use a different route, invoke the Node separately.
- Upsert partial failures, including HTTP
207 or nonempty metadata.lineErrors, mark the batch unsuccessful while preserving successful IDs and one-based error positions. Match errors against the original data array. Do not match successful record IDs to input records by their position in the response.
- Each upsert batch must be no larger than 40,000,000 bytes when serialized as UTF-8 JSON. The Node does not split batches or replay successful records.
- The Node completes the first query page or write before returning the output stream. It processes later pages and items as the output is consumed.
- Query failures return errors. Later handled write failures return rows with
Flowgear.IsSuccess set to false. Check this field before running work that depends on a successful write. Writes are not automatically retried when it is unclear whether the request succeeded.
- Audit requests that return an asynchronous job are polled at one-second intervals for at most 30 polls.
- If data changes during an export that uses offset paging, the exported records may not represent a single point in time.
Authorize supports temporary tokens, SAML exchange, and user-token clone, transfer, deactivate and delete operations. Temporary-token issuance requires an existing browser session; SAML exchange requires realm context but not an existing user token. Credential operations are not automatically persisted or retried.
- File upload uses attachment fields in upsert data. Downloads are buffered in memory and decoded once.
- Known string and integer lists use CSV where the template specifies it. Quote values containing commas, quotes or newlines, and double embedded quotes. Empty text represents an empty list;
"" represents one empty string. Integer lists do not accept added whitespace or fractions. Structured object arrays retain their child fields.
Select the record-upsert template under Create. Supply an Items object such as:
{
"to": "your-table-id",
"data": "[{\"6\":{\"value\":\"Example\"}}]",
"fieldsToReturn": "3,6"
}
Replace the table and field IDs with your application metadata. Field 6 is illustrative; its value must match the actual field type.
- XML APIs, webhook listeners, dynamic tenant-schema caching and secure-link authentication are not provided. Regional endpoints have not been verified.
- Administrative, analytics, document and solution operations require the corresponding Quickbase permissions and plan.