Provides integration with Quickbase applications, tables, records and administration through its JSON REST API. Use templates to query data, upsert 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. POST reads, including record queries and reports, accept one 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 provider records. Open-ended record data is returned as JSON text in Response.Value. |
Creates resources, upserts records or performs the selected provider 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 provider request. |
Options |
Object |
Route and query values required by the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached 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 provider request. |
Options |
Object |
Route and query values required by the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request. |
Deletes explicitly selected resources. Record deletion requires a nonempty where expression.
| 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 provider request. |
Options |
Object |
Route and query values required by the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached 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 |
Provider credential-operation result without a Flowgear.Request echo. |
- Query/report records use native Quickbase field-ID/value envelopes represented as JSON text in
Response.Value. For upsert, Items.data is JSON array text; dynamic table columns are not inferred.
- One mutation item is one complete provider request body. An empty input stream sends no requests. Supply an explicit empty object for a bodyless action.
Options apply to every item in the invocation.
- 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 assume successful response IDs align positionally with all input records.
- Supply complete upsert batches smaller than or equal to 40,000,000 serialized UTF-8 bytes. The Node does not split batches or replay successful records.
- The first page or write completes while the invocation is awaited; subsequent pages and items are consumed lazily. Query failures surface as errors. Later handled write failures return unsuccessful rows. Writes are not automatically retried after ambiguous failures.
- Audit requests that return an asynchronous job are polled at one-second intervals for at most 30 polls. Offset-based exports are not transactionally consistent with concurrent changes.
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.