Quickbase
App · 20 actions
Work with your Quickbase apps: find, create, update and delete records, run reports, and manage tables and fields.
Actions
| Action | What it does |
|---|---|
| Create field | Add a field to a table. |
| Create record | Add a record to a table. |
| Create table | Add a table to an app. |
| Delete field | Delete a field and the value it holds in every record. |
| Delete record | Delete one record by its Record ID#. |
| Delete records | Delete every record that matches a condition. |
| Delete table | Delete a table and every record in it. |
| Find records | Find records in a table, by condition and in the order you choose. |
| Get app | Get an app's name, description, time zone and dates. |
| Get field | Get one field: its label, type and settings. |
| Get record | Get one record, with every field, by its Record ID#. |
| Get report | Get a report's definition: its type, filter and columns. |
| Get table | Get one table: its name, record names, key field and size. |
| List fields | List a table's fields with their ids, labels and types. |
| List reports | List the reports saved on a table. |
| List tables | List every table in an app. |
| Run report | Run a saved report and return its records. |
| Update field | Change a field's label, help text or whether it is required or unique. |
| Update record | Change fields on an existing record. |
| Update table | Change a table's name, description or record names. |
Create field
Add a field to a table. Formula, lookup and multiple-choice fields need more setup; create those in Quickbase.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Label
labeltextRequired - The field's name.
- Type
field_typetext - What the field holds. Defaults to text.One of:
text(Text (default)),text-multi-line(Text, multi-line),rich-text(Rich text),numeric(Number),numeric-currency(Currency),numeric-percent(Percent),numeric-rating(Rating),date,timestamp(Date and time),checkbox, and 3 more. - Help text
help_texttext - Hint shown beside the field on forms.
- Required
requiredtrue/false - Whether every record must have a value for this field.
- Unique
uniquetrue/false - Whether no two records may share a value for this field.
Outputs
fieldobject- The new field
Example output
{
"field": {
"fieldHelp": "",
"fieldType": "text",
"id": 6,
"label": "Name",
"mode": "",
"properties": {},
"required": false,
"unique": false
}
}Create record
Add a record to a table. Quickbase fills in the Record ID#, dates and owner itself.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Fields
dataobjectRequired - The values to save, one per field. Fields you leave empty are not touched.
Outputs
recordobject- The record as saved: record_id and field labels
record_idnumber- The new Record ID#
Example output
{
"record": {
"Name": "Acme",
"Record ID#": 7,
"record_id": 7
},
"record_id": 7
}Create table
Add a table to an app. It starts with Quickbase's built-in fields; add more with 'Create field'.
Inputs
- App ID
app_idtext - Another app to use: the letters and digits after /db/ in its address, such as bqx3abc12. Leave empty for the app this connection was made with.
- Name
nametextRequired - The table's name.
- Description
descriptiontext - What the table is for.
- Name of one record
single_record_nametext - What one record is called, such as Customer. Defaults to Record.
- Name of many records
plural_record_nametext - What several are called, such as Customers. Defaults to Records.
Outputs
tableobject- The new table
Example output
{
"table": {
"alias": "_dbid_customers",
"created": "2026-01-05T09:00:00Z",
"description": "",
"id": "bqx3abc34",
"keyFieldId": 3,
"name": "Customers",
"nextFieldId": 9,
"nextRecordId": 8,
"pluralRecordName": "Customers",
"singleRecordName": "Customer",
"updated": "2026-10-01T09:00:00Z"
}
}Delete field
Delete a field and the value it holds in every record. Built-in fields cannot be deleted.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Field
field_idtextRequired - The field. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
field_idnumber- The field deleted
Example output
{
"deleted": true,
"field_id": 6
}Delete record
Delete one record by its Record ID#. This cannot be undone.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Record ID
record_idnumberRequired - The record's number (its Record ID#), from 'Find records' or 'Create record'.At least 1.
Outputs
deletedtrue/false- Always true once deleted
record_idnumber- The record deleted
Example output
{
"deleted": true,
"record_id": 7
}Delete records
Delete every record that matches a condition. This cannot be undone, so check the condition with 'Find records' first.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Condition
wheretextRequired - Which records to delete, in Quickbase's query format, for example {6.EX.'Acme'}. Required.
Outputs
deletedtrue/false- Always true once deleted
number_deletednumber- How many records were deleted
Example output
{
"deleted": true,
"number_deleted": 3
}Delete table
Delete a table and every record in it. This cannot be undone.
Inputs
- App ID
app_idtext - Another app to use: the letters and digits after /db/ in its address, such as bqx3abc12. Leave empty for the app this connection was made with.
- Table
table_idtextRequired - The table to delete. Pick one, or give its id.
Outputs
deletedtrue/false- Always true once deleted
table_idtext- The table deleted
Example output
{
"deleted": true,
"table_id": "bqx3abc34"
}Find records
Find records in a table, by condition and in the order you choose. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Condition
wheretext - Which records, in Quickbase's query format: {field id.operator.value}, for example {6.CT.'Acme'} for field 6 containing Acme, or {6.EX.'Acme'}AND{7.GT.100}. Leave empty to match every record.
- Fields to return
selectlist - Leave empty to return every field.
- Sort by
sort_fieldtext - The field to sort on. Without one, Quickbase's order.
- Order
sort_ordertext - Which way to sort. Defaults to ascending.One of:
ASC(Ascending (default)),DESC(Descending). - Page size
limitnumber - How many records to return, 1 to 1000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - How many records to skip, to get a later page. Use 'next_skip' from the page before.At least 0.
Outputs
countnumber- How many records are on this page
fieldslist- The columns returned
has_moretrue/false- True if more records match after this page
next_skipnumber- The 'Skip' that gets the next page, empty on the last
recordslist- The records, each with record_id and one key per field label
skipnumber- How many records were skipped
total_recordsnumber- How many records match in all
Example output
{
"count": 1,
"fields": [
{
"id": 3,
"label": "Record ID#",
"type": "recordid"
},
{
"id": 6,
"label": "Name",
"type": "text"
}
],
"has_more": false,
"next_skip": null,
"records": [
{
"Name": "Acme",
"Record ID#": 7,
"record_id": 7
}
],
"skip": 0,
"total_records": 1
}Get app
Get an app's name, description, time zone and dates. Also a quick way to check the token can see the app.
Inputs
- App ID
app_idtext - Another app to use: the letters and digits after /db/ in its address, such as bqx3abc12. Leave empty for the app this connection was made with.
Outputs
appobject- The app
Example output
{
"app": {
"created": "2026-01-05T09:00:00Z",
"dateFormat": "MM-DD-YYYY",
"description": "",
"hasEveryoneOnTheInternet": false,
"id": "bqx3abc12",
"name": "Customer CRM",
"timeZone": "(UTC-05:00) Eastern Time (US & Canada)",
"updated": "2026-10-01T09:00:00Z"
}
}Get field
Get one field: its label, type and settings.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Field
field_idtextRequired - The field. Pick one, or give its id from an earlier step.
Outputs
fieldobject- The field
Example output
{
"field": {
"fieldHelp": "",
"fieldType": "text",
"id": 6,
"label": "Name",
"mode": "",
"properties": {},
"required": false,
"unique": false
}
}Get record
Get one record, with every field, by its Record ID#.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Record ID
record_idnumberRequired - The record's number (its Record ID#), from 'Find records' or 'Create record'.At least 1.
Outputs
fieldslist- The columns returned
recordobject- The record: record_id and one key per field label
Example output
{
"fields": [
{
"id": 3,
"label": "Record ID#",
"type": "recordid"
},
{
"id": 6,
"label": "Name",
"type": "text"
}
],
"record": {
"Name": "Acme",
"Record ID#": 7,
"record_id": 7
}
}Get report
Get a report's definition: its type, filter and columns.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Report
report_idtextRequired - The report. Pick one, or give its id from an earlier step.
Outputs
reportobject- The report
Example output
{
"report": {
"description": "",
"id": "1",
"name": "List All",
"ownerId": 100000,
"type": "table",
"usedCount": 12
}
}Get table
Get one table: its name, record names, key field and size.
Inputs
- App ID
app_idtext - Another app to use: the letters and digits after /db/ in its address, such as bqx3abc12. Leave empty for the app this connection was made with.
- Table
table_idtextRequired - The table. Pick one, or give its id.
Outputs
tableobject- The table
Example output
{
"table": {
"alias": "_dbid_customers",
"created": "2026-01-05T09:00:00Z",
"description": "",
"id": "bqx3abc34",
"keyFieldId": 3,
"name": "Customers",
"nextFieldId": 9,
"nextRecordId": 8,
"pluralRecordName": "Customers",
"singleRecordName": "Customer",
"updated": "2026-10-01T09:00:00Z"
}
}List fields
List a table's fields with their ids, labels and types. Use the ids in 'Find records' conditions.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
Outputs
countnumber- How many
fieldslist- The fields
Example output
{
"count": 1,
"fields": [
{
"fieldHelp": "",
"fieldType": "text",
"id": 6,
"label": "Name",
"mode": "",
"properties": {},
"required": false,
"unique": false
}
]
}List reports
List the reports saved on a table.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
Outputs
countnumber- How many
reportslist- The reports
Example output
{
"count": 1,
"reports": [
{
"description": "",
"id": "1",
"name": "List All",
"ownerId": 100000,
"type": "table",
"usedCount": 12
}
]
}List tables
List every table in an app.
Inputs
- App ID
app_idtext - Another app to use: the letters and digits after /db/ in its address, such as bqx3abc12. Leave empty for the app this connection was made with.
Outputs
countnumber- How many
tableslist- The tables
Example output
{
"count": 1,
"tables": [
{
"alias": "_dbid_customers",
"created": "2026-01-05T09:00:00Z",
"description": "",
"id": "bqx3abc34",
"keyFieldId": 3,
"name": "Customers",
"nextFieldId": 9,
"nextRecordId": 8,
"pluralRecordName": "Customers",
"singleRecordName": "Customer",
"updated": "2026-10-01T09:00:00Z"
}
]
}Run report
Run a saved report and return its records. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Report
report_idtextRequired - The report. Pick one, or give its id from an earlier step.
- Page size
limitnumber - How many records to return, 1 to 1000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - How many records to skip, to get a later page. Use 'next_skip' from the page before.At least 0.
Outputs
countnumber- How many records are on this page
fieldslist- The columns returned
has_moretrue/false- True if more records match after this page
next_skipnumber- The 'Skip' that gets the next page, empty on the last
recordslist- The records, each with record_id and one key per field label
skipnumber- How many records were skipped
total_recordsnumber- How many records match in all
Example output
{
"count": 1,
"fields": [
{
"id": 3,
"label": "Record ID#",
"type": "recordid"
},
{
"id": 6,
"label": "Name",
"type": "text"
}
],
"has_more": false,
"next_skip": null,
"records": [
{
"Name": "Acme",
"Record ID#": 7,
"record_id": 7
}
],
"skip": 0,
"total_records": 1
}Update field
Change a field's label, help text or whether it is required or unique. A field's type cannot be changed.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Field
field_idtextRequired - The field. Pick one, or give its id from an earlier step.
- Label
labeltext - A new label. Leave empty to keep it.
- Help text
help_texttext - Hint shown beside the field on forms.
- Required
requiredtrue/false - Whether every record must have a value for this field.
- Unique
uniquetrue/false - Whether no two records may share a value for this field.
Outputs
fieldobject- The updated field
Example output
{
"field": {
"fieldHelp": "",
"fieldType": "text",
"id": 6,
"label": "Company",
"mode": "",
"properties": {},
"required": false,
"unique": false
}
}Update record
Change fields on an existing record. Only the fields given change.
Inputs
- Table
table_idtextRequired - The table. Pick one, or give its id from an earlier step.
- Record ID
record_idnumberRequired - The record's number (its Record ID#), from 'Find records' or 'Create record'.At least 1.
- Fields
dataobjectRequired - The values to save, one per field. Fields you leave empty are not touched.
Outputs
changedtrue/false- False if every value was already what you gave
recordobject- The record as saved: record_id and field labels
record_idnumber- The Record ID#
Example output
{
"changed": true,
"record": {
"Name": "Acme",
"Record ID#": 7,
"record_id": 7
},
"record_id": 7
}Update table
Change a table's name, description or record names.
Inputs
- App ID
app_idtext - Another app to use: the letters and digits after /db/ in its address, such as bqx3abc12. Leave empty for the app this connection was made with.
- Table
table_idtextRequired - The table. Pick one, or give its id.
- Name
nametext - A new name. Leave empty to keep it.
- Description
descriptiontext - What the table is for.
- Name of one record
single_record_nametext - What one record is called, such as Customer. Defaults to Record.
- Name of many records
plural_record_nametext - What several are called, such as Customers. Defaults to Records.
Outputs
tableobject- The updated table
Example output
{
"table": {
"alias": "_dbid_customers",
"created": "2026-01-05T09:00:00Z",
"description": "",
"id": "bqx3abc34",
"keyFieldId": 3,
"name": "Clients",
"nextFieldId": 9,
"nextRecordId": 8,
"pluralRecordName": "Customers",
"singleRecordName": "Customer",
"updated": "2026-10-01T09:00:00Z"
}
}