What can you do with it?
Create and manage custom applications and workflows using Quickbase, including retrieving table information, querying records, and inserting new data into your custom applications.
How to use it?
Basic Command Structure
/your-quickbase-connection [action] [required-parameters] [optional-parameters]
Parameters
Required:
action
- The operation to perform (get-tables, query-records, query-by-id, insert-records)
Optional:
app-id
- Quickbase application ID
table-id
- Quickbase table ID
limit
- Number of records to retrieve (default: 100)
Get Tables
Retrieve a list of tables in the specified Quickbase application
Parameters:
app-id
(required) - The Quickbase application ID
Example:
/your-quickbase-connection
action: get-tables
app-id: bq7abc123
Response:
{
"output": [
{
"alias": "_DBID_TABLE1",
"created": "2024-10-23T05:41:27Z",
"defaultSortFieldId": 2,
"defaultSortOrder": "DESC",
"description": "",
"id": "buk58j6w3",
"keyFieldId": 3,
"name": "table1",
"nextFieldId": 9,
"nextRecordId": 5,
"pluralRecordName": "table1S",
"singleRecordName": "table1",
"sizeLimit": "500 MB",
"spaceRemaining": "500 MB",
"spaceUsed": "1 KB",
"updated": "2024-10-30T17:49:46Z"
}
]
}
Query All Records
Retrieve all records from a specified table
Parameters:
table-id
(required) - The table ID to query
limit
(optional) - Maximum number of records to retrieve
Example:
/your-quickbase-connection
action: query-records
table-id: buk58j6w3
limit: 100
Response:
{
"output": {
"data": [
{
"7": {
"value": "dev23"
},
"8": {
"value": "dummy@test.com"
}
},
{
"7": {
"value": "John"
},
"8": {
"value": "Doe"
}
}
],
"fields": [
{
"id": 7,
"label": "Pinkfish Field 1",
"type": "text"
},
{
"id": 8,
"label": "Pinkfish Field 12",
"type": "text"
}
],
"metadata": {
"numFields": 2,
"numRecords": 4,
"skip": 0,
"totalRecords": 4
}
}
}
Query Records By ID
Retrieve specific records by their ID
Parameters:
table-id
(required) - The table ID to query
record-id
(required) - The specific record ID to retrieve
limit
(optional) - Maximum number of records to retrieve
Example:
/your-quickbase-connection
action: query-by-id
table-id: buk58j6w3
record-id: 2
limit: 100
Response:
{
"output": {
"data": [
{
"7": {
"value": "John"
},
"8": {
"value": "Doe"
}
}
],
"fields": [
{
"id": 7,
"label": "Pinkfish Field 1",
"type": "text"
},
{
"id": 8,
"label": "Pinkfish Field 12",
"type": "text"
}
],
"metadata": {
"numFields": 2,
"numRecords": 1,
"skip": 0,
"totalRecords": 1
}
}
}
Insert Records
Insert new records into a table
Parameters:
table-id
(required) - The table ID to insert records into
field-data
(required) - The field data to insert (field ID and value pairs)
Example:
/your-quickbase-connection
action: insert-records
table-id: buk58j6w3
field-data: Field 7: John, Field 8: Doe
Response:
{
"output": {
"data": [],
"metadata": {
"createdRecordIds": [
6
],
"totalNumberOfRecordsProcessed": 1,
"unchangedRecordIds": [],
"updatedRecordIds": []
}
}
}
Notes
Quickbase uses field IDs (numbers) to identify table columns. When querying records, data is returned using these field IDs as keys. The application ID is required for table operations, and table IDs are required for record operations.