Quickbase (Independent Publisher)

Quickbase is an application development platform that unites business and IT teams by enabling problem solvers of any technical background to work together to safely, securely and sustainably create an ecosystem of applications. Quickbase helps businesses accelerate the continuous innovation of unique processes by enabling citizen development at scale across one common platform.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Connector Metadata
Publisher	Troy Taylor, Hitachi Solutions
Website	https://www.quickbase.com/
Privacy policy	https://www.quickbase.com/privacy
Categories	Productivity;IT Operations

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Realm Hostname	string	Specify name of your realm hostname.	True
Authorization	securestring	The user token for in the form "QB-USER-TOKEN yourToken".	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Clone a user token	Clones the authenticated user token. All applications associated with that token are automatically associated with the new token.
Copy an app	Copies the specified application. The new application will have the same schema as the original. See below for additional copy options.
Create a field	Creates a field within a table, including the custom permissions of that field.
Create a relationship	Creates a relationship in a table as well as lookup/summary fields. Relationships can only be created for tables within the same app.
Create a table	Creates a table in an application.
Create an app	Creates an application in an account. You must have application creation rights in the respective account. Main properties and application variables can be set with this API.
Deactivate a user token	Deactivates the authenticated user token. Once this is done, the user token must be reactivated in the user interface.
Delete a relationship	Use this endpoint to delete an entire relationship, including all lookup and summary fields. The reference field in the relationship will not be deleted.
Delete a table	Deletes a specific table in an application, including all of the data within it.
Delete a user token	Deletes the authenticated user token. This is not reversible.
Delete an app	Deletes an entire application, including all of the tables and data.
Delete an attachment	Deletes one file attachment version. Meta-data about files can be retrieved from the /records and /reports endpoints, where applicable. Use those endpoints to get the necessary information to delete file versions.
Delete fields	Deletes one or many fields in a table, based on field id. This will also permanently delete any data or calculations in that field.
Delete records	Deletes record(s) in a table based on a query. Alternatively, all records in the table can be deleted.
Download an attachment	Downloads the file attachment, with the file attachment content encoded in base64 format. The API response returns the file name in the Content-Disposition header. Meta-data about files can be retrieved from the /records and /reports endpoints, where applicable. Use those endpoints to get the necessary information to fetch files.
Get a field usage	Get a single fields usage statistics. This is a summary of the information that can be found in the usage table of field properties.
Get a report	Get the schema (properties) of an individual report.
Get a table	Gets the properties of an individual table that is part of an application.
Get a temporary token for a DBID	Use this endpoint to get a temporary authorization token, scoped to either an app or a table. You can then use this token to make other API calls (see authorization). This token expires in 5 minutes.
Get all relationships	Get a list of all relationships, and their definitions, for a specific table. Details are provided for both the parent and child sides of relationships within a given application. Limited details are returned for cross-application relationships.
Get all table reports	Get the schema (properties) of all reports for a table. If the user running the API is an application administrator, the API will also return all personal reports with owner's user id.
Get an app	Returns the main properties of an application, including application variables.
Get app events	Get a list of events that can be triggered based on data or user actions in this application, includes: Email notification, Reminders, Subscriptions, QB Actions, Webhooks, record change triggered Automations (does not include scheduled).
Get field	Gets the properties of an individual field, based on field id. Properties present on all field types are returned at the top level. Properties unique to a specific type of field are returned under the 'properties' attribute. Please see Field types page for more details on the properties for each field type.
Get fields for a table	Gets the properties for all fields in a specific table. The properties for each field are the same as in Get field.
Get tables for an app	Gets a list of all the tables that exist in a specific application. The properties for each table are the same as what is returned in Get table.
Get usage for all fields	Get all the field usage statistics for a table. This is a summary of the information that can be found in the usage table of field properties.
Insert andor update records	Insert and/or update record(s) in a table. In this single API call, inserts and updates can be submitted. Update can use the key field on the table, or any other supported unique field. Refer to the Field types page for more information about how each field type should be formatted. This operation allows for incremental processing of successful records, even when some of the records fail. Note: This endpoint supports a maximum payload size of 10MB.
Query for data	Pass in a query in the Quickbase query language. Returns record data with intelligent pagination based on the approximate size of each record. The metadata object will include the necessary information to iterate over the response and gather more data.
Run a formula	Allows running a formula via an API call. Use this method in custom code to get the value back of a formula without a discrete field on a record.
Run a report	Runs a report, based on an ID and returns the underlying data associated with it. The format of the data will vary based on the report type. Reports that focus on record-level data (table, calendar, etc.) return the individual records. Aggregate reports (summary, chart) will return the summarized information as configured in the report. UI-specific elements are not returned, such as totals, averages and visualizations. Returns data with intelligent pagination based on the approximate size of each record. The metadata object will include the necessary information to iterate over the response and gather more data.
Update a field	Updates the properties and custom permissions of a field. The attempt to update certain properties might cause existing data to no longer obey the field’s new properties and may be rejected. See the descriptions of required, unique, and choices, below, for specific situations. Any properties of the field that you do not specify in the request body will remain unchanged.
Update a relationship	Use this endpoint to add lookup fields and summary fields to an existing relationship. Updating a relationship will not delete existing lookup/summary fields.
Update a table	Updates the main properties of a specific table. Any properties of the table that you do not specify in the request body will remain unchanged.
Update an app	Updates the main properties and/or application variables for a specific application. Any properties of the app that you do not specify in the request body will remain unchanged.

Clone a user token

Operation ID:

CloneUserToken

Clones the authenticated user token. All applications associated with that token are automatically associated with the new token.

Parameters

Name	Key	Required	Type	Description
name	name		string	The new name for the cloned user token.
description	description		string	The description for the cloned user token.

Returns

Clone User Token Response

cloneUserTokenResponse

Copy an app

Operation ID:

CopyApp

Copies the specified application. The new application will have the same schema as the original. See below for additional copy options.

Parameters

Name	Key	Required	Type	Description
name	name	True	string	The name of the newly copied app
description	description		string	The description of the newly copied app
assignUserToken	assignUserToken		boolean	Whether to add the user token used to make this request to the new app
excludeFiles	excludeFiles		boolean	If keepData is true, whether to copy the file attachments as well. If keepData is false, this property is ignored
keepData	keepData		boolean	Whether to copy the app's data along with the schema
usersAndRoles	usersAndRoles		boolean	If true, users will be copied along with their assigned roles. If false, users and roles will be copied but roles will not be assigned
App ID	appId	True	string	The unique identifier of an app.

Returns

Copy App Response

copyAppResponse

Create a field

Operation ID:

CreateField

Creates a field within a table, including the custom permissions of that field.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier of the table.
audited	audited		boolean	Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under Quickbase Audit Logs.
fieldHelp	fieldHelp		string	The configured help text shown to users within the product.
bold	bold		boolean	Indicates if the field is configured to display in bold in the product.
comments	comments		string	The comments entered on the field properties by an administrator.
doesTotal	doesTotal		boolean	Whether this field totals in reports within the product.
autoSave	autoSave		boolean	Whether the link field will auto save.
defaultValueLuid	defaultValueLuid		integer	Default user id value.
maxVersions	maxVersions		integer	The maximum number of versions configured for a file attachment.
format	format		integer	The format to display time.
carryChoices	carryChoices		boolean	Whether the field should carry its multiple choice fields when copied.
maxLength	maxLength		integer	The maximum number of characters allowed for entry in Quickbase for this field.
linkText	linkText		string	The configured text value that replaces the URL that users see within the product.
parentFieldId	parentFieldId		integer	The id of the parent composite field, when applicable.
displayTimezone	displayTimezone		boolean	Indicates whether to display the timezone within the product.
allowNewChoices	allowNewChoices		boolean	Indicates if users can add new choices to a selection list.
defaultToday	defaultToday		boolean	Indicates if the field value is defaulted today for new records.
units	units		string	The units label.
sourceFieldId	sourceFieldId		integer	The id of the source field.
doesAverage	doesAverage		boolean	Whether this field averages in reports within the product.
formula	formula		string	The formula of the field as configured in Quickbase.
decimalPlaces	decimalPlaces		integer	The number of decimal places displayed in the product for this field.
displayMonth	displayMonth		string	How to display months.
seeVersions	seeVersions		boolean	Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.
numLines	numLines		integer	The number of lines shown in Quickbase for this text field.
defaultKind	defaultKind		string	The user default type.
displayEmail	displayEmail		string	How the email is displayed.
coverText	coverText		string	An alternate user friendly text that can be used to display a link in the browser.
currencySymbol	currencySymbol		string	The current symbol used when displaying field values within the product.
targetFieldId	targetFieldId		integer	The id of the target field.
displayUser	displayUser		string	The configured option for how users display within the product.
blankIsZero	blankIsZero		boolean	Whether a blank value is treated the same as 0 in calculations within the product.
exact	exact		boolean	Whether an exact match is required for a report link.
defaultDomain	defaultDomain		string	Default email domain.
defaultValue	defaultValue		string	The default value configured for a field when a new record is added.
abbreviate	abbreviate		boolean	Don't show the URL protocol when showing the URL.
numberFormat	numberFormat		integer	The format used for displaying numeric values in the product (decimal, separators, digit group).
targetTableName	targetTableName		string	The field's target table name.
appearsAs	appearsAs		string	The link text, if empty, the url will be used as link text.
width	width		integer	The field's html input width in the product.
CurrencyFormat	currencyFormat		string	The currency format used when displaying field values within the product.
displayImages	displayImages		boolean	Indicates whether images will display for file attachments on forms and reports within the product.
displayDayOfWeek	displayDayOfWeek		boolean	Indicates whether to display the day of the week within the product.
commaStart	commaStart		integer	The number of digits before commas display in the product, when applicable.
choices	choices		array of string	An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.
targetTableId	targetTableId		string	The id of the target table.
displayRelative	displayRelative		boolean	Whether to display time as relative.
compositeFields	compositeFields		object
displayTime	displayTime		boolean	Indicates whether to display the time, in addition to the date.
VersionMode	versionMode		string	Version modes for files. Keep all versions vs keep last version.
snapFieldId	snapFieldId		integer	The id of the field that is used to snapshot values from, when applicable.
hours24	hours24		boolean	Indicates whether or not to display time in the 24-hour format within the product.
sortAlpha	sortAlpha		boolean	Whether to sort alphabetically, default sort is by record ID.
sortAsGiven	sortAsGiven		boolean	Indicates if the listed entries sort as entered vs alphabetically.
hasExtension	hasExtension		boolean	Whether this field has a phone extension.
useNewWindow	useNewWindow		boolean	Indicates if the URL should open a new window when a user clicks it within the product.
appendOnly	appendOnly		boolean	Whether this field is append only.
displayAsLink	displayAsLink		boolean	Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.
appearsByDefault	appearsByDefault		boolean	Indicates if the field is marked as a default in reports.
FieldType2	fieldType	True	string	The field types, click on any of the field type links for more info.
role	role		string	The role associated with a given permission for the field
permissionType	permissionType		string	The permission given to the role for this field
roleId	roleId		integer	The Id of the given role
addToForms	addToForms		boolean	Whether the field you are adding should appear on forms.
label	label	True	string	The label (name) of the field.
findEnabled	findEnabled		boolean	Indicates if the field is marked as searchable.
noWrap	noWrap		boolean	Indicates if the field is configured to not wrap when displayed in the product.

Returns

Create Field Response

createFieldResponse

Create a relationship

Operation ID:

CreateRelationship

Creates a relationship in a table as well as lookup/summary fields. Relationships can only be created for tables within the same app.

Parameters

Name	Key	Required	Type	Description
summaryFid	summaryFid		double	The field id to summarize.
label	label		string	The label for the summary field.
AccumulationType	accumulationType	True	string	The accumulation type for the summary field.
where	where		string	The filter, using the Quickbase query language, which determines the records to return.
lookupFieldIds	lookupFieldIds		array of integer	Array of field ids in the parent table that will become lookup fields in the child table.
parentTableId	parentTableId	True	string	The parent table id for the relationship.
label	label		string	The label for the foreign key field.
Table ID	tableId	True	string	The unique identifier (DBID) of the table. This will be the child table.

Returns

Create Relationship Response

createRelationshipResponse

Create a table

Operation ID:

CreateTable

Creates a table in an application.

Parameters

Name	Key	Required	Type	Description
App ID	appId	True	string	The unique identifier of an app
name	name	True	string	The name for the table.
pluralRecordName	pluralRecordName		string	The plural noun for records in the table. If this value is not passed the default value is 'Records'.
singleRecordName	singleRecordName		string	The singular noun for records in the table. If this value is not passed the default value is 'Record'.
description	description		string	The description for the table. If this value is not passed the default value is blank.

Returns

Create Table Response

createTableResponse

Create an app

Operation ID:

CreateApp

Creates an application in an account. You must have application creation rights in the respective account. Main properties and application variables can be set with this API.

Parameters

Name	Key	Required	Type	Description
assignToken	assignToken		boolean	Set to true if you would like to assign the app to the user token you used to create the application. The default is false.
name	name	True	string	The name for the variable.
value	value	True	string	The value for the variable.
name	name	True	string	The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this.
description	description		string	The description for the app. If this property is left out, the app description will be blank.

Returns

Create App Response

createAppResponse

Deactivate a user token

Operation ID:

DeactivateUserToken

Deactivates the authenticated user token. Once this is done, the user token must be reactivated in the user interface.

Returns

Name	Path	Type	Description
id	id	integer	id

Delete a relationship

Operation ID:

DeleteRelationship

Use this endpoint to delete an entire relationship, including all lookup and summary fields. The reference field in the relationship will not be deleted.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier (DBID) of the table. This will be the child table.
Relationship ID	relationshipId	True	double	The relationship ID. This is the field ID of the reference field on the child table.

Returns

Delete Relationship Response

deleteRelationshipResponse

Delete a table

Operation ID:

DeleteTable

Deletes a specific table in an application, including all of the data within it.

Parameters

Name	Key	Required	Type	Description
App ID	appId	True	string	The unique identifier of an app
Table ID	tableId	True	string	The unique identifier (DBID) of the table.

Returns

Delete Table Response

deleteTableResponse

Delete a user token

Operation ID:

DeleteUserToken

Deletes the authenticated user token. This is not reversible.

Returns

Delete User Token Response

deleteUserTokenResponse

Delete an app

Operation ID:

DeleteApp

Deletes an entire application, including all of the tables and data.

Parameters

Name	Key	Required	Type	Description
name	name	True	string	To confirm application deletion we ask for application name.
App ID	appId	True	string	The unique identifier of an app.

Returns

Delete App Response

deleteAppResponse

Delete an attachment

Operation ID:

DeleteFile

Deletes one file attachment version. Meta-data about files can be retrieved from the /records and /reports endpoints, where applicable. Use those endpoints to get the necessary information to delete file versions.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier of the table.
Record ID	recordId	True	integer	The unique identifier of the record.
Field ID	fieldId	True	integer	The unique identifier of the field.
Version Number	versionNumber	True	integer	The file attachment version number.

Returns

Delete File Response

deleteFileResponse

Delete fields

Operation ID:

DeleteFields

Deletes one or many fields in a table, based on field id. This will also permanently delete any data or calculations in that field.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier of the table.
fieldIds	fieldIds	True	array of integer	List of field ids to be deleted.

Returns

Delete Fields Response

deleteFieldsResponse

Delete records

Operation ID:

DeleteRecords

Deletes record(s) in a table based on a query. Alternatively, all records in the table can be deleted.

Parameters

Name	Key	Required	Type	Description
from	from	True	string	The unique identifier of the table.
where	where	True	string	The filter to delete records. To delete all records specify a filter that will include all records, for example {3.GT.0} where 3 is the ID of the Record ID field.

Returns

Delete Records Response

deleteRecordsResponse

Download an attachment

Operation ID:

DownloadFile

Downloads the file attachment, with the file attachment content encoded in base64 format. The API response returns the file name in the Content-Disposition header. Meta-data about files can be retrieved from the /records and /reports endpoints, where applicable. Use those endpoints to get the necessary information to fetch files.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier of the table.
Record ID	recordId	True	integer	The unique identifier of the record.
Field ID	fieldId	True	integer	The unique identifier of the field.
Version Number	versionNumber	True	integer	The file attachment version number.

Returns

response

string

Get a field usage

Operation ID:

GetFieldUsage

Get a single fields usage statistics. This is a summary of the information that can be found in the usage table of field properties.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier (DBID) of the table.
Field ID	fieldId	True	integer	The unique identifier (FID) of the field.

Returns

Name	Path	Type	Description
		array of object
ID	field.id	integer	The identifier.
Name	field.name	string	The name.
Type	field.type	string	The type.
Count	usage.actions.count	integer	The count.
Count	usage.appHomePages.count	integer	The count.
Count	usage.defaultReports.count	integer	The count.
Count	usage.exactForms.count	integer	The count.
Count	usage.fields.count	integer	The count.
Count	usage.forms.count	integer	The count.
Count	usage.notifications.count	integer	The count.
Count	usage.personalReports.count	integer	The count.
Count	usage.relationships.count	integer	The count.
Count	usage.reminders.count	integer	The count.
Count	usage.reports.count	integer	The count.
Count	usage.roles.count	integer	The count.
Count	usage.webhooks.count	integer	The count.

Get a report

Operation ID:

GetReport

Get the schema (properties) of an individual report.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier of table.
Report ID	reportId	True	string	The identifier of the report, unique to the table.

Returns

Get Report Response

getReportResponse

Get a table

Operation ID:

GetTable

Gets the properties of an individual table that is part of an application.

Parameters

Name	Key	Required	Type	Description
App ID	appId	True	string	The unique identifier of an app
Table ID	tableId	True	string	The unique identifier (DBID) of the table.

Returns

Get Table Response

getTableResponse

Get a temporary token for a DBID

Operation ID:

GetTempTokenDBID

Use this endpoint to get a temporary authorization token, scoped to either an app or a table. You can then use this token to make other API calls (see authorization). This token expires in 5 minutes.

Parameters

Name	Key	Required	Type	Description
App Token	QB-App-Token		string	Your Quickbase app token
DBID	dbid	True	string	The unique identifier of an app or table.

Returns

getTempTokenDBIDResponse

getTempTokenDBIDResponse

Get all relationships

Operation ID:

GetRelationships

Get a list of all relationships, and their definitions, for a specific table. Details are provided for both the parent and child sides of relationships within a given application. Limited details are returned for cross-application relationships.

Parameters

Name	Key	Required	Type	Description
Skip	skip		integer	The number of relationships to skip.
Table ID	tableId	True	string	The unique identifier (DBID) of the table.

Returns

Get Relationships Response

getRelationshipsResponse

Get all table reports

Operation ID:

GetTableReports

Get the schema (properties) of all reports for a table. If the user running the API is an application administrator, the API will also return all personal reports with owner's user id.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier of the table.

Returns

Name	Path	Type	Description
		array of object
ID	id	string	The identifier.
Name	name	string	The name.
Type	type	string	The type.
Description	description	string	The description.
Owner ID	ownerId	string	The identifier of the owner.
Used Last	usedLast	string	When used last.
Used Count	usedCount	integer	The used count.

Get an app

Operation ID:

GetApp

Returns the main properties of an application, including application variables.

Parameters

Name	Key	Required	Type	Description
App ID	appId	True	string	The unique identifier of an app.

Returns

Get App Response

getAppResponse

Get app events

Operation ID:

GetAppEvents

Get a list of events that can be triggered based on data or user actions in this application, includes: Email notification, Reminders, Subscriptions, QB Actions, Webhooks, record change triggered Automations (does not include scheduled).

Parameters

Name	Key	Required	Type	Description
App ID	appId	True	string	The unique identifier of an app.

Returns

Name	Path	Type	Description
		array of object
Type	type	string	The type.
Email	owner.email	string	The owner's email address.
ID	owner.id	string	The owner's identifier.
Name	owner.name	string	The owner's name.
User Name	owner.userName	string	The owner's user name.
Is Active	isActive	boolean	Whether is active.
Table ID	tableId	string	The identifier of the table.
Name	name	string	The name.
URL	url	string	The URL address.

Get field

Operation ID:

GetField

Gets the properties of an individual field, based on field id.
Properties present on all field types are returned at the top level. Properties unique to a specific type of field are returned under the 'properties' attribute. Please see Field types page for more details on the properties for each field type.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier (DBID) of the table.
Include Field Permissions	includeFieldPerms		boolean	Set to 'true' if you'd like to get back the custom permissions for the field(s).
Field ID	fieldId	True	integer	The unique identifier (FID) of the field.

Returns

Get Field Response

getFieldResponse

Get fields for a table

Operation ID:

GetFields

Gets the properties for all fields in a specific table. The properties for each field are the same as in Get field.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier (DBID) of the table.
Include Field Permissions	includeFieldPerms		boolean	Set to 'true' if you'd like to get back the custom permissions for the field(s).

Returns

Name	Path	Type	Description
		array of object
ID	id	integer	The identifier.
Label	label	string	The label.
Field Type	fieldType	string	The field type.
No Wrap	noWrap	boolean	Whether there is no wrap.
Bold	bold	boolean	Whether bold.
Required	required	boolean	Whether required.
Appears By Default	appearsByDefault	boolean	Whether appears by default.
Find Enabled	findEnabled	boolean	Whether find is enabled.
Unique	unique	boolean	Whether unique.
Does Data Copy	doesDataCopy	boolean	Whether does data copy.
Field Help	fieldHelp	string	The field help.
Audited	audited	boolean	Whether audited.
Primary Key	properties.primaryKey	boolean	Whether the primary key.
Foreign Key	properties.foreignKey	boolean	Whether the foreign key.
Num Lines	properties.numLines	integer	The number of lines.
Max Length	properties.maxLength	integer	The maximum length.
Append Only	properties.appendOnly	boolean	Whether append only.
allowHTML	properties.allowHTML	boolean	Whether to allow HTML.
Sort As Given	properties.sortAsGiven	boolean	Whether sort as given.
Carry Choices	properties.carryChoices	boolean	Whether to carry choices.
Allow New Choices	properties.allowNewChoices	boolean	Whether to allow new choices.
Formula	properties.formula	string	The formula.
Default Value	properties.defaultValue	string	The default value.
Number Format	properties.numberFormat	integer	The number format.
Decimal Places	properties.decimalPlaces	integer	The decimal places.
Does Average	properties.doesAverage	boolean	Whether does average.
Does Total	properties.doesTotal	boolean	Whether does total.
Blank Is Zero	properties.blankIsZero	boolean	Whether blank is zero.
Permissions	permissions	array of object
Permission Type	permissions.permissionType	string	The permission type.
Role	permissions.role	string	The role.
Role ID	permissions.roleId	integer	The identifier of the role.
Add To Forms	addToForms	boolean	Whether to add to forms.

Get tables for an app

Operation ID:

GetAppTables

Gets a list of all the tables that exist in a specific application. The properties for each table are the same as what is returned in Get table.

Parameters

Name	Key	Required	Type	Description
App ID	appId	True	string	The unique identifier of an app

Returns

Name	Path	Type	Description
		array of object
Name	name	string	The name.
Created	created	string	When created.
Updated	updated	string	When updated.
Alias	alias	string	The alias.
Description	description	string	The description.
ID	id	string	The identifier.
Next Record ID	nextRecordId	integer	The identifier of the next record.
Next Field ID	nextFieldId	integer	The identifier of the next field.
Default Sort Field ID	defaultSortFieldId	integer	The identifier of the default sort field.
Default Sort Order	defaultSortOrder	string	The default sort order.
Key Field ID	keyFieldId	integer	The identifier of the key field.
Single Record Name	singleRecordName	string	The single record name.
Plural Record Name	pluralRecordName	string	The plural record name.
Size Limit	sizeLimit	string	The size limit.
Space Used	spaceUsed	string	The used space.
Space Remaining	spaceRemaining	string	The remaining space.

Get usage for all fields

Operation ID:

GetFieldsUsage

Get all the field usage statistics for a table. This is a summary of the information that can be found in the usage table of field properties.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier (DBID) of the table.
Skip	skip		integer	The number of fields to skip from the list.
Top	top		integer	The maximum number of fields to return.

Returns

Name	Path	Type	Description
		array of object
ID	field.id	integer	The identifier.
Name	field.name	string	The name.
Type	field.type	string	The type.
Count	usage.actions.count	integer	The count.
Count	usage.appHomePages.count	integer	The count.
Count	usage.defaultReports.count	integer	The count.
Count	usage.exactForms.count	integer	The count.
Count	usage.fields.count	integer	The count.
Count	usage.forms.count	integer	The count.
Count	usage.notifications.count	integer	The count.
Count	usage.personalReports.count	integer	The count.
Count	usage.relationships.count	integer	The count.
Count	usage.reminders.count	integer	The count.
Count	usage.reports.count	integer	The count.
Count	usage.roles.count	integer	The count.
Count	usage.webhooks.count	integer	The count.

Insert andor update records

Operation ID:

UpsertRecords

Insert and/or update record(s) in a table. In this single API call, inserts and updates can be submitted. Update can use the key field on the table, or any other supported unique field. Refer to the Field types page for more information about how each field type should be formatted. This operation allows for incremental processing of successful records, even when some of the records fail.
Note: This endpoint supports a maximum payload size of 10MB.

Parameters

Name	Key	Required	Type	Description
to	to	True	string	The table identifier.
data	data		object
mergeFieldId	mergeFieldId		integer	The merge field id.
fieldsToReturn	fieldsToReturn		array of integer	Specify an array of field ids that will return data for any updates or added record. Record ID (FID 3) is always returned if any field ID is requested.

Returns

A successful response that includes details on the records added, updated or unchanged. In the example below, the table previously had ten records with IDs from 1 through 10. The user posts an upsert that updates the value of record 1 and adds two new records, all successfully.

Upsert Response

upsertResponse

Query for data

Operation ID:

RunQuery

Pass in a query in the Quickbase query language. Returns record data with intelligent pagination based on the approximate size of each record. The metadata object will include the necessary information to iterate over the response and gather more data.

Parameters

Name	Key	Required	Type	Description
skip	skip		integer	The number of records to skip.
compareWithAppLocalTime	compareWithAppLocalTime		boolean	Whether to run the query against a date time field with respect to the application's local time. The query is run with UTC time by default.
top	top		integer	The maximum number of records to display.
where	where		string	The filter, using the Quickbase query language, which determines the records to return. If this parameter is omitted, the query will return all records.
fieldId	fieldId		integer	The unique identifier of a field in a table.
Grouping	grouping		string	Group by based on ascending order (ASC), descending order (DESC) or equal values (equal-values)
sortBy	sortBy		object	By default, queries will be sorted by the given sort fields or the default sort if the query does not provide any. Set to false to avoid sorting when the order of the data returned is not important. Returning data without sorting can improve performance.
select	select		object
from	from	True	string	The table identifier.

Returns

Run Query Response

runQueryResponse

Run a formula

Operation ID:

RunFormula

Allows running a formula via an API call. Use this method in custom code to get the value back of a formula without a discrete field on a record.

Parameters

Name	Key	Required	Type	Description
formula	formula	True	string	The formula to run. This must be a valid Quickbase formula.
rid	rid		integer	The record ID to run the formula against. Only necessary for formulas that are run in the context of a record. For example, the formula User() does not need a record ID.
from	from	True	string	The unique identifier (dbid) of the table.

Returns

Run Formula Response

runFormulaResponse

Run a report

Operation ID:

RunReport

Runs a report, based on an ID and returns the underlying data associated with it. The format of the data will vary based on the report type. Reports that focus on record-level data (table, calendar, etc.) return the individual records. Aggregate reports (summary, chart) will return the summarized information as configured in the report. UI-specific elements are not returned, such as totals, averages and visualizations. Returns data with intelligent pagination based on the approximate size of each record. The metadata object will include the necessary information to iterate over the response and gather more data.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The identifier of the table for the report.
Skip	skip		integer	The number of records to skip. You can set this value when paginating through a set of results.
Top	top		integer	The maximum number of records to return. You can override the default Quickbase pagination to get more or fewer results. If your requested value here exceeds the dynamic maximums, we will return a subset of results and the rest can be gathered in subsequent API calls.
			object
Report ID	reportId	True	string	The identifier of the report, unique to the table.

Returns

Run Report Response

runReportResponse

Update a field

Operation ID:

UpdateField

Updates the properties and custom permissions of a field. The attempt to update certain properties might cause existing data to no longer obey the field’s new properties and may be rejected. See the descriptions of required, unique, and choices, below, for specific situations. Any properties of the field that you do not specify in the request body will remain unchanged.

Parameters

Name	Key	Required	Type	Description
Table ID	tableId	True	string	The unique identifier of the table.
audited	audited		boolean	Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under Quickbase Audit Logs.
fieldHelp	fieldHelp		string	The configured help text shown to users within the product.
bold	bold		boolean	Indicates if the field is configured to display in bold in the product.
required	required		boolean	Indicates if the field is required (i.e. if every record must have a non-null value in this field). If you attempt to change a field from not-required to required, and the table currently contains records that have null values in that field, you will get an error indicating that there are null values of the field. In this case you need to find and update those records with null values of the field before changing the field to required.
comments	comments		string	The comments entered on the field properties by an administrator.
doesTotal	doesTotal		boolean	Whether this field totals in reports within the product.
autoSave	autoSave		boolean	Whether the link field will auto save.
defaultValueLuid	defaultValueLuid		integer	Default user id value.
maxVersions	maxVersions		integer	The maximum number of versions configured for a file attachment.
format	format		integer	The format to display time.
carryChoices	carryChoices		boolean	Whether the field should carry its multiple choice fields when copied.
maxLength	maxLength		integer	The maximum number of characters allowed for entry in Quickbase for this field.
linkText	linkText		string	The configured text value that replaces the URL that users see within the product.
parentFieldId	parentFieldId		integer	The id of the parent composite field, when applicable.
displayTimezone	displayTimezone		boolean	Indicates whether to display the timezone within the product.
summaryTargetFieldId	summaryTargetFieldId		integer	The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).
allowNewChoices	allowNewChoices		boolean	Indicates if users can add new choices to a selection list.
defaultToday	defaultToday		boolean	Indicates if the field value is defaulted today for new records.
units	units		string	The units label.
lookupTargetFieldId	lookupTargetFieldId		integer	The id of the field that is the target on the parent table for this lookup.
SummaryFunction3	summaryFunction		string	The accumulation type for the summary field.
sourceFieldId	sourceFieldId		integer	The id of the source field.
doesAverage	doesAverage		boolean	Whether this field averages in reports within the product.
formula	formula		string	The formula of the field as configured in Quickbase.
decimalPlaces	decimalPlaces		integer	The number of decimal places displayed in the product for this field.
displayMonth	displayMonth		string	How to display months.
seeVersions	seeVersions		boolean	Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.
numLines	numLines		integer	The number of lines shown in Quickbase for this text field.
defaultKind	defaultKind		string	The user default type.
displayEmail	displayEmail		string	How the email is displayed.
coverText	coverText		string	An alternate user friendly text that can be used to display a link in the browser.
currencySymbol	currencySymbol		string	The current symbol used when displaying field values within the product.
summaryQuery	summaryQuery		string	The summary query.
targetFieldId	targetFieldId		integer	The id of the target field.
displayUser	displayUser		string	The configured option for how users display within the product.
blankIsZero	blankIsZero		boolean	Whether a blank value is treated the same as 0 in calculations within the product.
exact	exact		boolean	Whether an exact match is required for a report link.
defaultDomain	defaultDomain		string	Default email domain.
defaultValue	defaultValue		string	The default value configured for a field when a new record is added.
abbreviate	abbreviate		boolean	Don't show the URL protocol when showing the URL.
numberFormat	numberFormat		integer	The format used for displaying numeric values in the product (decimal, separators, digit group).
targetTableName	targetTableName		string	The field's target table name.
appearsAs	appearsAs		string	The link text, if empty, the url will be used as link text.
width	width		integer	The field's html input width in the product.
CurrencyFormat	currencyFormat		string	The currency format used when displaying field values within the product.
displayImages	displayImages		boolean	Indicates whether images will display for file attachments on forms and reports within the product.
displayDayOfWeek	displayDayOfWeek		boolean	Indicates whether to display the day of the week within the product.
summaryReferenceFieldId	summaryReferenceFieldId		integer	The id of the field that is the reference in the relationship for this summary.
commaStart	commaStart		integer	The number of digits before commas display in the product, when applicable.
choices	choices		array of string	An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.
targetTableId	targetTableId		string	The id of the target table.
displayRelative	displayRelative		boolean	Whether to display time as relative.
compositeFields	compositeFields		object
summaryTableId	summaryTableId		string	The table the summary field references fields from.
displayTime	displayTime		boolean	Indicates whether to display the time, in addition to the date.
VersionMode	versionMode		string	Version modes for files. Keep all versions vs keep last version.
snapFieldId	snapFieldId		integer	The id of the field that is used to snapshot values from, when applicable.
hours24	hours24		boolean	Indicates whether or not to display time in the 24-hour format within the product.
sortAlpha	sortAlpha		boolean	Whether to sort alphabetically, default sort is by record ID.
sortAsGiven	sortAsGiven		boolean	Indicates if the listed entries sort as entered vs alphabetically.
hasExtension	hasExtension		boolean	Whether this field has a phone extension.
useNewWindow	useNewWindow		boolean	Indicates if the URL should open a new window when a user clicks it within the product.
appendOnly	appendOnly		boolean	Whether this field is append only.
displayAsLink	displayAsLink		boolean	Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.
lookupReferenceFieldId	lookupReferenceFieldId		integer	The id of the field that is the reference in the relationship for this lookup.
appearsByDefault	appearsByDefault		boolean	Indicates if the field is marked as a default in reports.
unique	unique		boolean	Indicates if every record in the table must contain a unique value of this field. If you attempt to change a field from not-unique to unique, and the table currently contains records with the same value of this field, you will get an error. In this case you need to find and update those records with duplicate values of the field before changing the field to unique.
role	role		string	The role associated with a given permission for the field
permissionType	permissionType		string	The permission given to the role for this field
roleId	roleId		integer	The Id of the given role
addToForms	addToForms		boolean	Whether the field you are adding should appear on forms.
label	label		string	The label (name) of the field.
findEnabled	findEnabled		boolean	Indicates if the field is marked as searchable.
noWrap	noWrap		boolean	Indicates if the field is configured to not wrap when displayed in the product.
Field ID	fieldId	True	integer	The unique identifier (FID) of the field.

Returns

Update Field Response

updateFieldResponse

Update a relationship

Operation ID:

UpdateRelationship

Use this endpoint to add lookup fields and summary fields to an existing relationship. Updating a relationship will not delete existing lookup/summary fields.

Parameters

Name	Key	Required	Type	Description
summaryFid	summaryFid		double	The field id to summarize.
label	label		string	The label for the summary field.
AccumulationType	accumulationType	True	string	The accumulation type for the summary field.
where	where		string	The filter, using the Quickbase query language, which determines the records to return.
lookupFieldIds	lookupFieldIds		array of integer	An array of field ids on the parent table that will become lookup fields on the child table.
Table ID	tableId	True	string	The unique identifier (DBID) of the table. This will be the child table.
Relationship ID	relationshipId	True	double	The relationship ID. This is the field ID of the reference field on the child table.

Returns

Update Relationship Response

updateRelationshipResponse

Update a table

Operation ID:

UpdateTable

Updates the main properties of a specific table. Any properties of the table that you do not specify in the request body will remain unchanged.

Parameters

Name	Key	Required	Type	Description
App ID	appId	True	string	The unique identifier of an app
name	name		string	The name for the table.
pluralRecordName	pluralRecordName		string	The plural noun for records in the table. If this value is not passed the default value is 'Records'.
singleRecordName	singleRecordName		string	The singular noun for records in the table. If this value is not passed the default value is 'Record'.
description	description		string	The description for the table. If this value is not passed the default value is blank.
Table ID	tableId	True	string	The unique identifier (DBID) of the table.

Returns

Update Table Response

updateTableResponse

Update an app

Operation ID:

UpdateApp

Updates the main properties and/or application variables for a specific application. Any properties of the app that you do not specify in the request body will remain unchanged.

Parameters

Name	Key	Required	Type	Description
name	name	True	string	The name for the variable.
value	value	True	string	The value for the variable.
name	name		string	The name for the app.
description	description		string	The description for the app.
App ID	appId	True	string	The unique identifier of an app.

Returns

Update App Response

updateAppResponse

Definitions

createAppResponse

Name	Path	Type	Description
name	name	string	The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this.
description	description	string	The description for the app. If this property is left out, the app description will be blank.
created	created	string	The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
updated	updated	string	The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
dateFormat	dateFormat	string	A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the Field type details page in the API Guide for how time values are returned in API calls. See About Localizing Dates to set the app’s date format.
timeZone	timeZone	string	A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the Field type details page in the portal for how time values are returned in API calls. See Set the Time Zone for Both the Application and the Account to set the application’s time zone.
id	id	string	The unique identifier for this application.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indicates whether app includes Everyone On The Internet access. See Sharing apps with Everyone on the Internet (EOTI).
variables	variables	array of Variable1	The app variables. See About Application Variables
dataClassification	dataClassification	string	The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans.

Variable1

Name	Path	Type	Description
name	name	string	Variable name.
value	value	string	Variable value.

getAppResponse

Name	Path	Type	Description
name	name	string	The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this.
description	description	string	The description for the app. If this property is left out, the app description will be blank.
created	created	string	The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
updated	updated	string	The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
dateFormat	dateFormat	string	A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the Field type details page in the API Guide for how time values are returned in API calls. See About Localizing Dates to set the app’s date format.
timeZone	timeZone	string	A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the Field type details page in the portal for how time values are returned in API calls. See Set the Time Zone for Both the Application and the Account to set the application’s time zone.
id	id	string	The unique identifier for this application.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indicates whether app includes Everyone On The Internet access. See Sharing apps with Everyone on the Internet (EOTI).
variables	variables	array of Variable1	The app variables. See About Application Variables
dataClassification	dataClassification	string	The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans.

updateAppResponse

Name	Path	Type	Description
name	name	string	The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this.
description	description	string	The description for the app. If this property is left out, the app description will be blank.
created	created	string	The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
updated	updated	string	The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
dateFormat	dateFormat	string	A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the Field type details page in the API Guide for how time values are returned in API calls. See About Localizing Dates to set the app’s date format.
timeZone	timeZone	string	A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the Field type details page in the portal for how time values are returned in API calls. See Set the Time Zone for Both the Application and the Account to set the application’s time zone.
id	id	string	The unique identifier for this application.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indicates whether app includes Everyone On The Internet access. See Sharing apps with Everyone on the Internet (EOTI).
variables	variables	array of Variable1	The app variables. See About Application Variables
dataClassification	dataClassification	string	The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans.

deleteAppResponse

Name	Path	Type	Description
deletedAppId	deletedAppId	string	An ID of deleted application.

copyAppResponse

Name	Path	Type	Description
name	name	string	The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this.
description	description	string	The description for the app
created	created	string	The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
updated	updated	string	The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
dateFormat	dateFormat	string	A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the Field type details page in the API Guide for how time values are returned in API calls. See About Localizing Dates to set the app’s date format.
timeZone	timeZone	string	A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the Field type details page in the portal for how time values are returned in API calls. See Set the Time Zone for Both the Application and the Account to set the application’s time zone.
id	id	string	The unique identifier for this application.
hasEveryoneOnTheInternet	hasEveryoneOnTheInternet	boolean	Indicates whether app includes Everyone On The Internet access. See Sharing apps with Everyone on the Internet (EOTI).
variables	variables	array of Variable1	The app variables. See About Application Variables
ancestorId	ancestorId	string	The id of the app from which this app was copied
dataClassification	dataClassification	string	The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans.

createTableResponse

Name	Path	Type	Description
name	name	string	The name of the table.
id	id	string	The unique identifier (dbid) of the table.
alias	alias	string	The automatically-created table alias for the table.
description	description	string	The description of the table, as configured by an application administrator.
created	created	string	The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
updated	updated	string	The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
nextRecordId	nextRecordId	integer	The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.
nextFieldId	nextFieldId	integer	The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.
defaultSortFieldId	defaultSortFieldId	integer	The id of the field that is configured for default sorting.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	The configuration of the default sort order on the table.
keyFieldId	keyFieldId	integer	The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.
singleRecordName	singleRecordName	string	The builder-configured singular noun of the table.
pluralRecordName	pluralRecordName	string	The builder-configured plural noun of the table.
sizeLimit	sizeLimit	string	The size limit for the table.
spaceUsed	spaceUsed	string	The amount of space currently being used by the table.
spaceRemaining	spaceRemaining	string	The amount of space remaining for use by the table.

DefaultSortOrder

The configuration of the default sort order on the table.

The configuration of the default sort order on the table.

DefaultSortOrder

string

getTableResponse

Name	Path	Type	Description
name	name	string	The name of the table.
id	id	string	The unique identifier (dbid) of the table.
alias	alias	string	The automatically-created table alias for the table.
description	description	string	The description of the table, as configured by an application administrator.
created	created	string	The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
updated	updated	string	The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
nextRecordId	nextRecordId	integer	The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.
nextFieldId	nextFieldId	integer	The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.
defaultSortFieldId	defaultSortFieldId	integer	The id of the field that is configured for default sorting.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	The configuration of the default sort order on the table.
keyFieldId	keyFieldId	integer	The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.
singleRecordName	singleRecordName	string	The builder-configured singular noun of the table.
pluralRecordName	pluralRecordName	string	The builder-configured plural noun of the table.
sizeLimit	sizeLimit	string	The size limit for the table.
spaceUsed	spaceUsed	string	The amount of space currently being used by the table.
spaceRemaining	spaceRemaining	string	The amount of space remaining for use by the table.

updateTableResponse

Name	Path	Type	Description
name	name	string	The name of the table.
id	id	string	The unique identifier (dbid) of the table.
alias	alias	string	The automatically-created table alias for the table.
description	description	string	The description of the table, as configured by an application administrator.
created	created	string	The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
updated	updated	string	The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
nextRecordId	nextRecordId	integer	The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.
nextFieldId	nextFieldId	integer	The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.
defaultSortFieldId	defaultSortFieldId	integer	The id of the field that is configured for default sorting.
DefaultSortOrder	defaultSortOrder	DefaultSortOrder	The configuration of the default sort order on the table.
keyFieldId	keyFieldId	integer	The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.
singleRecordName	singleRecordName	string	The builder-configured singular noun of the table.
pluralRecordName	pluralRecordName	string	The builder-configured plural noun of the table.
sizeLimit	sizeLimit	string	The size limit for the table.
spaceUsed	spaceUsed	string	The amount of space currently being used by the table.
spaceRemaining	spaceRemaining	string	The amount of space remaining for use by the table.

deleteTableResponse

Name	Path	Type	Description
deletedTableId	deletedTableId	string	The deleted table id.

getRelationshipsResponse

Name	Path	Type	Description
relationships	relationships	array of Relationship	The relationships in a table.
Metadata	metadata	Metadata	Additional information about the results that may be helpful.

Relationship

Name	Path	Type	Description
id	id	integer	The relationship id (foreign key field id).
parentTableId	parentTableId	string	The parent table id of the relationship.
childTableId	childTableId	string	The child table id of the relationship.
ForeignKeyField	foreignKeyField	ForeignKeyField	The foreign key field information.
isCrossApp	isCrossApp	boolean	Whether this is a cross-app relationship.
lookupFields	lookupFields	array of LookupField	The lookup fields array.
summaryFields	summaryFields	array of SummaryField	The summary fields array.

ForeignKeyField

The foreign key field information.

Name	Path	Type	Description
id	id	integer	Field id.
label	label	string	Field label.
type	type	string	Field type.

LookupField

Name	Path	Type	Description
id	id	integer	Field id.
label	label	string	Field label.
type	type	string	Field type.

SummaryField

Name	Path	Type	Description
id	id	integer	Field id.
label	label	string	Field label.
type	type	string	Field type.

Metadata

Additional information about the results that may be helpful.

Name	Path	Type	Description
skip	skip	integer	The number of relationships to skip.
totalRelationships	totalRelationships	integer	The total number of relationships.
numRelationships	numRelationships	integer	The number of relationships in the current response object.

createRelationshipResponse

Name	Path	Type	Description
id	id	integer	The relationship id (foreign key field id).
parentTableId	parentTableId	string	The parent table id of the relationship.
childTableId	childTableId	string	The child table id of the relationship.
ForeignKeyField	foreignKeyField	ForeignKeyField	The foreign key field information.
isCrossApp	isCrossApp	boolean	Whether this is a cross-app relationship.
lookupFields	lookupFields	array of LookupField	The lookup fields array.
summaryFields	summaryFields	array of SummaryField	The summary fields array.

updateRelationshipResponse

Name	Path	Type	Description
id	id	integer	The relationship id (foreign key field id).
parentTableId	parentTableId	string	The parent table id of the relationship.
childTableId	childTableId	string	The child table id of the relationship.
ForeignKeyField	foreignKeyField	ForeignKeyField	The foreign key field information.
isCrossApp	isCrossApp	boolean	Whether this is a cross-app relationship.
lookupFields	lookupFields	array of LookupField	The lookup fields array.
summaryFields	summaryFields	array of SummaryField	The summary fields array.

deleteRelationshipResponse

Name	Path	Type	Description
relationshipId	relationshipId	integer	The relationship id.

Query

The query definition as configured in Quickbase that gets executed when the report is run.

Name	Path	Type	Description
tableId	tableId	string	The table identifier for the report.
filter	filter	string	Filter used to query for data.
formulaFields	formulaFields	array of FormulaField	Calculated formula fields.

FormulaField

Name	Path	Type	Description
id	id	integer	Formula field identifier.
label	label	string	Formula field label.
FieldType	fieldType	FieldType	Resulting formula value type.
formula	formula	string	Formula text.
decimalPrecision	decimalPrecision	integer	For numeric formula the number precision.

FieldType

Resulting formula value type.

Resulting formula value type.

FieldType

string

getReportResponse

Name	Path	Type	Description
id	id	string	The identifier of the report, unique to the table.
name	name	string	The configured name of the report.
type	type	string	The type of report in Quickbase (e.g., chart).
description	description	string	The configured description of a report.
ownerId	ownerId	integer	Optional, showed only for personal reports. The user ID of report owner.
Query	query	Query	The query definition as configured in Quickbase that gets executed when the report is run.
properties	properties	object	A list of properties specific to the report type. To see a detailed description of the properties for each report type, See Report Types.
usedLast	usedLast	string	The instant at which a report was last used.
usedCount	usedCount	integer	The number of times a report has been used.

runReportResponse

Name	Path	Type	Description
fields	fields	array of Field	An array of objects that contains limited meta-data of each field displayed in the report. This assists in building logic that depends on field types and IDs.
data	data	array of object	An array of objects that either represents the record data or summarized values, depending on the report type.
items	data	object
Metadata1	metadata	Metadata1	Additional information about the results that may be helpful. Pagination may be needed if either you specify a smaller number of results to skip than is available, or if the API automatically returns fewer results. numRecords can be compared to totalRecords to determine if further pagination is needed.

Field

Name	Path	Type	Description
id	id	integer	Field id.
label	label	string	Field label.
type	type	string	Field type.
labelOverride	labelOverride	string	Column heading label override for field in report.

Metadata1

Additional information about the results that may be helpful. Pagination may be needed if either you specify a smaller number of results to skip than is available, or if the API automatically returns fewer results. numRecords can be compared to totalRecords to determine if further pagination is needed.

Name	Path	Type	Description
skip	skip	integer	The number of records to skip
numFields	numFields	integer	The number of fields in each record in the current response object
top	top	integer	If present, the maximum number of records requested by the caller
totalRecords	totalRecords	integer	The total number of records in the result set
numRecords	numRecords	integer	The number of records in the current response object

Properties1

Additional properties for the field. Please see Field type details page for more details on the properties for each field type.

Name	Path	Type	Description
comments	comments	string	The comments entered on the field properties by an administrator.
doesTotal	doesTotal	boolean	Whether this field totals in reports within the product.
autoSave	autoSave	boolean	Whether the link field will auto save.
defaultValueLuid	defaultValueLuid	integer	Default user id value.
maxVersions	maxVersions	integer	The maximum number of versions configured for a file attachment.
carryChoices	carryChoices	boolean	Whether the field should carry its multiple choice fields when copied.
format	format	integer	The format to display time.
maxLength	maxLength	integer	The maximum number of characters allowed for entry in Quickbase for this field.
linkText	linkText	string	The configured text value that replaces the URL that users see within the product.
parentFieldId	parentFieldId	integer	The id of the parent composite field, when applicable.
displayTimezone	displayTimezone	boolean	Indicates whether to display the timezone within the product.
summaryTargetFieldId	summaryTargetFieldId	integer	The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).
allowNewChoices	allowNewChoices	boolean	Indicates if users can add new choices to a selection list.
masterChoiceFieldId	masterChoiceFieldId	integer	The id of the field that is the reference in the relationship.
defaultToday	defaultToday	boolean	Indicates if the field value is defaulted today for new records.
units	units	string	The units label.
lookupTargetFieldId	lookupTargetFieldId	integer	The id of the field that is the target on the master table for this lookup.
SummaryFunction	summaryFunction	SummaryFunction	The summary accumulation function type.
sourceFieldId	sourceFieldId	integer	The id of the source field.
masterTableTag	masterTableTag	string	The table alias for the master table in the relationship this field is part of.
doesAverage	doesAverage	boolean	Whether this field averages in reports within the product.
formula	formula	string	The formula of the field as configured in Quickbase.
decimalPlaces	decimalPlaces	integer	The number of decimal places displayed in the product for this field.
seeVersions	seeVersions	boolean	Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.
displayMonth	displayMonth	string	How to display months.
numLines	numLines	integer	The number of lines shown in Quickbase for this text field.
displayEmail	displayEmail	string	How the email is displayed.
defaultKind	defaultKind	string	The user default type.
coverText	coverText	string	An alternate user friendly text that can be used to display a link in the browser.
currencySymbol	currencySymbol	string	The current symbol used when displaying field values within the product.
masterChoiceTableId	masterChoiceTableId	integer	The id of the table that is the master in this relationship.
targetFieldId	targetFieldId	integer	The id of the target field.
displayUser	displayUser	string	The configured option for how users display within the product.
blankIsZero	blankIsZero	boolean	Whether a blank value is treated the same as 0 in calculations within the product.
exact	exact	boolean	Whether an exact match is required for a report link.
startField	startField	integer	The start field id.
defaultDomain	defaultDomain	string	Default email domain.
defaultValue	defaultValue	string	The default value configured for a field when a new record is added.
choicesLuid	choicesLuid	array of object	List of user choices.
items	choicesLuid	object
abbreviate	abbreviate	boolean	Don't show the URL protocol when showing the URL.
xmlTag	xmlTag	string	The field's xml tag.
targetTableName	targetTableName	string	The field's target table name.
numberFormat	numberFormat	integer	The format used for displaying numeric values in the product (decimal, separators, digit group).
appearsAs	appearsAs	string	The link text, if empty, the url will be used as link text.
width	width	integer	The field's html input width in the product.
CurrencyFormat	currencyFormat	CurrencyFormat	The currency format used when displaying field values within the product.
displayImages	displayImages	boolean	Indicates whether images will display for file attachments on forms and reports within the product.
foreignKey	foreignKey	boolean	Indicates if the field is a foreign key (or reference field) in a relationship.
displayDayOfWeek	displayDayOfWeek	boolean	Indicates whether to display the day of the week within the product.
summaryReferenceFieldId	summaryReferenceFieldId	integer	The id of the field that is the reference in the relationship for this summary.
commaStart	commaStart	integer	The number of digits before commas display in the product, when applicable.
choices	choices	array of string	An array of entries that exist for a field that offers choices to the user.
targetTableId	targetTableId	string	The id of the target table.
displayRelative	displayRelative	boolean	Whether to display time as relative.
compositeFields	compositeFields	array of object	An array of the fields that make up a composite field (e.g., address).
items	compositeFields	object
VersionMode	versionMode	VersionMode	Version modes for files. Keep all versions vs keep last version.
displayTime	displayTime	boolean	Indicates whether to display the time, in addition to the date.
durationField	durationField	integer	The duration field id.
snapFieldId	snapFieldId	integer	The id of the field that is used to snapshot values from, when applicable.
hours24	hours24	boolean	Indicates whether or not to display time in the 24-hour format within the product.
sortAlpha	sortAlpha	boolean	Whether to sort alphabetically, default sort is by record ID.
sortAsGiven	sortAsGiven	boolean	Indicates if the listed entries sort as entered vs alphabetically.
hasExtension	hasExtension	boolean	Whether this field has a phone extension.
workWeek	workWeek	integer	The work week type.
useNewWindow	useNewWindow	boolean	Indicates if the URL should open a new window when a user clicks it within the product.
appendOnly	appendOnly	boolean	Whether this field is append only.
displayAsLink	displayAsLink	boolean	Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.
allowHTML	allowHTML	boolean	Whether this field allows html.
lookupReferenceFieldId	lookupReferenceFieldId	integer	The id of the field that is the reference in the relationship for this lookup.

SummaryFunction

The summary accumulation function type.

The summary accumulation function type.

SummaryFunction

string

CurrencyFormat

The currency format used when displaying field values within the product.

The currency format used when displaying field values within the product.

CurrencyFormat

string

VersionMode

Version modes for files. Keep all versions vs keep last version.

Version modes for files. Keep all versions vs keep last version.

VersionMode

string

Permission

Name	Path	Type	Description
role	role	string	The role associated with a given permission for the field
permissionType	permissionType	string	The permission given to the role for this field
roleId	roleId	integer	The Id of the given role

createFieldResponse

Name	Path	Type	Description
id	id	integer	The id of the field, unique to this table.
fieldType	fieldType	string	The type of field, as described here.
mode	mode	string	For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.
label	label	string	The label (name) of the field.
noWrap	noWrap	boolean	Indicates if the field is configured to not wrap when displayed in the product.
bold	bold	boolean	Indicates if the field is configured to display in bold in the product.
required	required	boolean	Indicates if the field is marked required.
appearsByDefault	appearsByDefault	boolean	Indicates if the field is marked as a default in reports.
findEnabled	findEnabled	boolean	Indicates if the field is marked as searchable.
unique	unique	boolean	Indicates if the field is marked unique.
doesDataCopy	doesDataCopy	boolean	Indicates if the field data will copy when a user copies the record.
fieldHelp	fieldHelp	string	The configured help text shown to users within the product.
audited	audited	boolean	Indicates if the field is being tracked as part of Quickbase Audit Logs.
Properties1	properties	Properties1	Additional properties for the field. Please see Field type details page for more details on the properties for each field type.
permissions	permissions	array of Permission	Field Permissions for different roles.

deleteFieldsResponse

Name	Path	Type	Description
deletedFieldIds	deletedFieldIds	array of integer	List of field ids to were deleted.
errors	errors	array of string	List of errors found.

getFieldResponse

Name	Path	Type	Description
id	id	integer	The id of the field, unique to this table.
fieldType	fieldType	string	The type of field, as described here.
mode	mode	string	For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.
label	label	string	The label (name) of the field.
noWrap	noWrap	boolean	Indicates if the field is configured to not wrap when displayed in the product.
bold	bold	boolean	Indicates if the field is configured to display in bold in the product.
required	required	boolean	Indicates if the field is marked required.
appearsByDefault	appearsByDefault	boolean	Indicates if the field is marked as a default in reports.
findEnabled	findEnabled	boolean	Indicates if the field is marked as searchable.
unique	unique	boolean	Indicates if the field is marked unique.
doesDataCopy	doesDataCopy	boolean	Indicates if the field data will copy when a user copies the record.
fieldHelp	fieldHelp	string	The configured help text shown to users within the product.
audited	audited	boolean	Indicates if the field is being tracked as part of Quickbase Audit Logs.
Properties1	properties	Properties1	Additional properties for the field. Please see Field type details page for more details on the properties for each field type.
permissions	permissions	array of Permission	Field Permissions for different roles.

updateFieldResponse

Name	Path	Type	Description
id	id	integer	The id of the field, unique to this table.
fieldType	fieldType	string	The type of field, as described here.
mode	mode	string	For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.
label	label	string	The label (name) of the field.
noWrap	noWrap	boolean	Indicates if the field is configured to not wrap when displayed in the product.
bold	bold	boolean	Indicates if the field is configured to display in bold in the product.
required	required	boolean	Indicates if the field is marked required.
appearsByDefault	appearsByDefault	boolean	Indicates if the field is marked as a default in reports.
findEnabled	findEnabled	boolean	Indicates if the field is marked as searchable.
unique	unique	boolean	Indicates if the field is marked unique.
doesDataCopy	doesDataCopy	boolean	Indicates if the field data will copy when a user copies the record.
fieldHelp	fieldHelp	string	The configured help text shown to users within the product.
audited	audited	boolean	Indicates if the field is being tracked as part of Quickbase Audit Logs.
Properties1	properties	Properties1	Additional properties for the field. Please see Field type details page for more details on the properties for each field type.
permissions	permissions	array of Permission	Field Permissions for different roles.

runFormulaResponse

Name	Path	Type	Description
result	result	string	The formula execution result.

upsertResponse

A successful response that includes details on the records added, updated or unchanged. In the example below, the table previously had ten records with IDs from 1 through 10. The user posts an upsert that updates the value of record 1 and adds two new records, all successfully.

Name	Path	Type	Description
Metadata2	metadata	Metadata2	Information about created records, updated records, referenced but unchanged records, and records having any errors while being processed.
data	data	array of object	The data that is expected to be returned.
items	data	object

Metadata2

Information about created records, updated records, referenced but unchanged records, and records having any errors while being processed.

Name	Path	Type	Description
createdRecordIds	createdRecordIds	array of integer	Array containing the created record ids.
lineErrors	lineErrors	object	This will only be returned in the case of failed records. It is a collection of errors that occurred when processing the incoming data that resulted in records not being processed. Each object has a key representing the sequence number of the record in the original payload (starting from 1). The value is a list of errors occurred.
unchangedRecordIds	unchangedRecordIds	array of integer	Array containing the unchanged record ids.
updatedRecordIds	updatedRecordIds	array of integer	Array containing the updated record ids.
totalNumberOfRecordsProcessed	totalNumberOfRecordsProcessed	integer	Number of records processed. Includes successful and failed record updates.

deleteRecordsResponse

Name	Path	Type	Description
numberDeleted	numberDeleted	integer	The number of records deleted.

runQueryResponse

Name	Path	Type	Description
fields	fields	array of Fields2	An array of objects that contains limited meta-data of each field displayed in the report. This assists in building logic that depends on field types and IDs.
data	data	array of object	An array of objects that either represents the record data or summarized values, depending on the report type.
items	data	object
Metadata1	metadata	Metadata1	Additional information about the results that may be helpful. Pagination may be needed if either you specify a smaller number of results to skip than is available, or if the API automatically returns fewer results. numRecords can be compared to totalRecords to determine if further pagination is needed.

Fields2

Name	Path	Type	Description
id	id	integer	Field id.
label	label	string	Field label.
type	type	string	Field type.

getTempTokenDBIDResponse

Name	Path	Type	Description
temporaryAuthorization	temporaryAuthorization	string	Temporary authorization token.

cloneUserTokenResponse

Name	Path	Type	Description
active	active	boolean	Whether the user token is active.
apps	apps	array of App	The list of apps this user token is assigned to.
lastUsed	lastUsed	string	The last date this user token was used, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
description	description	string	User Token description.
id	id	integer	User Token id.
name	name	string	User Token name.
token	token	string	User Token value.

App

Name	Path	Type	Description
id	id	string	The unique identifier for this application.
name	name	string	The application's name.

deleteUserTokenResponse

Name	Path	Type	Description
id	id	integer	The user token id.

deleteFileResponse

Name	Path	Type	Description
versionNumber	versionNumber	integer	The number of deleted version.
fileName	fileName	string	The name of file associated with deleted version.
uploaded	uploaded	string	The timestamp when the version was originally uploaded.
Creator	creator	Creator	The user that uploaded version.

Creator

The user that uploaded version.

Name	Path	Type	Description
name	name	string	User full name.
id	id	string	User Id.
email	email	string	User email.
userName	userName	string	User Name as updated in user properties. Optional, appears if not the same as user email.

string

This is the basic data type 'string'.