quickbase-js

Appearance

Documentation of the available API methods. For full project details and features, see the GitHub repository.

createApp

POST /apps

Create an app

https://developer.quickbase.com/operation/createApp

Parameters

  • body (CreateAppRequest, optional): No description
    • name (string, required): The name of the app.
    • description (string, optional): A description for the app.
    • assignToken (boolean, required): Whether to assign the user token.

Returns

CreateApp200Response

  • name (string, required): 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 (string, optional): The description for the app. If this property is left out, the app description will be blank.
  • created (string, optional): 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 (string, optional): 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 (string, optional): 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](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format.
  • timeZone (string, optional): 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](../fieldInfo) 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](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone.
  • memoryInfo (object, optional): Application memory info
  • id (string, optional): The unique identifier for this application.
  • hasEveryoneOnTheInternet (boolean, optional): Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)
  • variables (any, optional): The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)
  • dataClassification (string, optional): 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.
  • securityProperties (object, optional): Security properties of the application

getApp

GET /apps/{appId}

Get an app

https://developer.quickbase.com/operation/getApp

Parameters

  • appId (string, required): The unique identifier of an app

Returns

GetApp200Response

  • ancestorId (string, optional): The id of the app from which this app was copied
  • name (string, required): 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 (string, optional): The description for the app. If this property is left out, the app description will be blank.
  • created (string, optional): 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 (string, optional): 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 (string, optional): 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](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format.
  • timeZone (string, optional): 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](../fieldInfo) 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](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone.
  • memoryInfo (object, optional): Application memory info
  • id (string, optional): The unique identifier for this application.
  • hasEveryoneOnTheInternet (boolean, optional): Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)
  • variables (any, optional): The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)
  • dataClassification (string, optional): 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.
  • securityProperties (object, optional): Security properties of the application

updateApp

POST /apps/{appId}

Update an app

https://developer.quickbase.com/operation/updateApp

Parameters

  • appId (string, required): The unique identifier of an app
  • body (UpdateAppRequest, optional): No description
    • name (string, required): The name of the app.
    • description (string, optional): A description for the app.
    • assignToken (boolean, required): Whether to assign the user token.

Returns

UpdateApp200Response

  • ancestorId (string, optional): The id of the app from which this app was copied
  • name (string, required): 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 (string, optional): The description for the app. If this property is left out, the app description will be blank.
  • created (string, optional): 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 (string, optional): 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 (string, optional): 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](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format.
  • timeZone (string, optional): 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](../fieldInfo) 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](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone.
  • memoryInfo (object, optional): Application memory info
  • id (string, optional): The unique identifier for this application.
  • hasEveryoneOnTheInternet (boolean, optional): Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)
  • variables (any, optional): The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)
  • dataClassification (string, optional): 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.
  • securityProperties (object, optional): Security properties of the application

deleteApp

DELETE /apps/{appId}

Delete an app

https://developer.quickbase.com/operation/deleteApp

Parameters

  • appId (string, required): The unique identifier of an app
  • body (DeleteAppRequest, optional): No description
    • name (string, required): The name of the app.
    • description (string, optional): A description for the app.
    • assignToken (boolean, required): Whether to assign the user token.

Returns

DeleteApp200Response

  • deletedAppId (string, optional): An ID of deleted application.

getAppEvents

GET /apps/{appId}/events

Get app events

https://developer.quickbase.com/operation/getAppEvents

Parameters

  • appId (string, required): The unique identifier of an app

Returns

GetAppEvents200Response

  • isActive (boolean, optional): Indication of whether current event is active.
  • type (string, optional): Type of an event.
  • name (string, optional): The name of the event. This property is not returned for automations.
  • url (string, optional): The url to automation that can be accessed from the browser. Only returned for automations.
  • owner (object, optional): The user that owns the event.
  • tableId (string, optional): The unique identifier of the table to which event belongs to.

copyApp

POST /apps/{appId}/copy

Copy an app

https://developer.quickbase.com/operation/copyApp

Parameters

  • appId (string, required): The unique identifier of an app
  • body (CopyAppRequest, optional): No description
    • name (string, required): The name of the new app.
    • description (string, optional): A description for the new app.
    • properties (CopyAppRequestProperties, optional): No description

Returns

CopyApp200Response

  • name (string, required): 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 (string, optional): The description for the app
  • created (string, optional): 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 (string, optional): 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 (string, optional): 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](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format.
  • timeZone (string, optional): 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](../fieldInfo) 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](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone.
  • id (string, optional): The unique identifier for this application.
  • hasEveryoneOnTheInternet (boolean, optional): Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)
  • variables (any, optional): The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)
  • ancestorId (string, optional): The id of the app from which this app was copied
  • dataClassification (string, optional): 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.

createTable

POST /tables

Create a table

https://developer.quickbase.com/operation/createTable

Parameters

  • appId (string, required): The unique identifier of an app
  • body (CreateTableRequest, optional): No description
    • name (string, required): The name for the table.
    • description (string, optional): The description for the table...
    • singleRecordName (string, optional): The singular noun for records...
    • pluralRecordName (string, optional): The plural noun for records...

Returns

CreateTable200Response

  • name (string, optional): The name of the table.
  • id (string, optional): The unique identifier (dbid) of the table.
  • alias (string, optional): The automatically-created table alias for the table.
  • description (string, optional): The description of the table, as configured by an application administrator.
  • created (string, optional): 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 (string, optional): 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 (number, optional): The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.
  • nextFieldId (number, optional): The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.
  • defaultSortFieldId (number, optional): The id of the field that is configured for default sorting.
  • defaultSortOrder (string, optional): The configuration of the default sort order on the table.
  • keyFieldId (number, optional): The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.
  • singleRecordName (string, optional): The builder-configured singular noun of the table.
  • pluralRecordName (string, optional): The builder-configured plural noun of the table.
  • sizeLimit (string, optional): The size limit for the table.
  • spaceUsed (string, optional): The amount of space currently being used by the table.
  • spaceRemaining (string, optional): The amount of space remaining for use by the table.

getAppTables

GET /tables

Get tables for an app

https://developer.quickbase.com/operation/getAppTables

Parameters

  • appId (string, required): The unique identifier of an app

Returns

GetAppTables200Response

  • name (string, optional): The name of the table.
  • id (string, optional): The unique identifier (dbid) of the table.
  • alias (string, optional): The automatically-created table alias for the table.
  • description (string, optional): The description of the table, as configured by an application administrator.
  • created (string, optional): 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 (string, optional): 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 (number, optional): The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.
  • nextFieldId (number, optional): The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.
  • defaultSortFieldId (number, optional): The id of the field that is configured for default sorting.
  • defaultSortOrder (string, optional): The configuration of the default sort order on the table.
  • keyFieldId (number, optional): The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.
  • singleRecordName (string, optional): The builder-configured singular noun of the table.
  • pluralRecordName (string, optional): The builder-configured plural noun of the table.
  • sizeLimit (string, optional): The size limit for the table.
  • spaceUsed (string, optional): The amount of space currently being used by the table.
  • spaceRemaining (string, optional): The amount of space remaining for use by the table.

getTable

GET /tables/{tableId}

Get a table

https://developer.quickbase.com/operation/getTable

Parameters

  • appId (string, required): The unique identifier of an app
  • tableId (string, required): The unique identifier (dbid) of the table.

Returns

GetTable200Response

  • name (string, optional): The name of the table.
  • id (string, optional): The unique identifier (dbid) of the table.
  • alias (string, optional): The automatically-created table alias for the table.
  • description (string, optional): The description of the table, as configured by an application administrator.
  • created (string, optional): 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 (string, optional): 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 (number, optional): The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.
  • nextFieldId (number, optional): The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.
  • defaultSortFieldId (number, optional): The id of the field that is configured for default sorting.
  • defaultSortOrder (string, optional): The configuration of the default sort order on the table.
  • keyFieldId (number, optional): The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.
  • singleRecordName (string, optional): The builder-configured singular noun of the table.
  • pluralRecordName (string, optional): The builder-configured plural noun of the table.
  • sizeLimit (string, optional): The size limit for the table.
  • spaceUsed (string, optional): The amount of space currently being used by the table.
  • spaceRemaining (string, optional): The amount of space remaining for use by the table.

updateTable

POST /tables/{tableId}

Update a table

https://developer.quickbase.com/operation/updateTable

Parameters

  • appId (string, required): The unique identifier of an app
  • tableId (string, required): The unique identifier (dbid) of the table.
  • body (UpdateTableRequest, optional): No description
    • name (string, optional): The updated name of the table.
    • description (string, optional): The updated description for the table.

Returns

UpdateTable200Response

  • name (string, optional): The name of the table.
  • id (string, optional): The unique identifier (dbid) of the table.
  • alias (string, optional): The automatically-created table alias for the table.
  • description (string, optional): The description of the table, as configured by an application administrator.
  • created (string, optional): 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 (string, optional): 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 (number, optional): The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.
  • nextFieldId (number, optional): The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.
  • defaultSortFieldId (number, optional): The id of the field that is configured for default sorting.
  • defaultSortOrder (string, optional): The configuration of the default sort order on the table.
  • keyFieldId (number, optional): The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.
  • singleRecordName (string, optional): The builder-configured singular noun of the table.
  • pluralRecordName (string, optional): The builder-configured plural noun of the table.
  • sizeLimit (string, optional): The size limit for the table.
  • spaceUsed (string, optional): The amount of space currently being used by the table.
  • spaceRemaining (string, optional): The amount of space remaining for use by the table.

deleteTable

DELETE /tables/{tableId}

Delete a table

https://developer.quickbase.com/operation/deleteTable

Parameters

  • appId (string, required): The unique identifier of an app
  • tableId (string, required): The unique identifier (dbid) of the table.

Returns

DeleteTable200Response

  • deletedTableId (string, optional): The deleted table id.

getRelationships

GET /tables/{tableId}/relationships

Get all relationships

https://developer.quickbase.com/operation/getRelationships

Parameters

  • skip (number, optional): The number of relationships to skip.
  • tableId (string, required): The unique identifier (dbid) of the child table.

Returns

GetRelationships200Response

  • relationships (any, required): The relationships in a table.
  • metadata (object, optional): Additional information about the results that may be helpful.

createRelationship

POST /tables/{tableId}/relationship

Create a relationship

https://developer.quickbase.com/operation/createRelationship

Parameters

  • tableId (string, required): The unique identifier (dbid) of the table. This will be the child table.
  • body (CreateRelationshipRequest, optional): No description
    • parentTableId (string, required): The parent table id for the relationship.
    • foreignKeyField ({ [key: string]: any; }, optional): No description
    • lookupFieldIds (number[], optional): Array of field ids...
    • summaryFields ({ [key: string]: any; }[], optional): Array of summary field objects...

Returns

CreateRelationship200Response

  • id (number, required): The relationship id (foreign key field id).
  • parentTableId (string, required): The parent table id of the relationship.
  • childTableId (string, required): The child table id of the relationship.
  • foreignKeyField (object, optional): The foreign key field information.
  • isCrossApp (boolean, required): Whether this is a cross-app relationship.
  • lookupFields (any, optional): The lookup fields array.
  • summaryFields (any, optional): The summary fields array.

updateRelationship

POST /tables/{tableId}/relationship/{relationshipId}

Update a relationship

https://developer.quickbase.com/operation/updateRelationship

Parameters

  • tableId (string, required): The unique identifier (dbid) of the table. This will be the child table.
  • relationshipId (number, required): The relationship id. This is the field id of the reference field on the child table.
  • body (UpdateRelationshipRequest, optional): No description
    • parentTableId (string, optional): The updated parent table id...
    • foreignKeyField ({ [key: string]: any; }, optional): No description
    • lookupFieldIds (number[], optional): Updated array of field ids...
    • summaryFields ({ [key: string]: any; }[], optional): No description

Returns

UpdateRelationship200Response

  • id (number, required): The relationship id (foreign key field id).
  • parentTableId (string, required): The parent table id of the relationship.
  • childTableId (string, required): The child table id of the relationship.
  • foreignKeyField (object, optional): The foreign key field information.
  • isCrossApp (boolean, required): Whether this is a cross-app relationship.
  • lookupFields (any, optional): The lookup fields array.
  • summaryFields (any, optional): The summary fields array.

deleteRelationship

DELETE /tables/{tableId}/relationship/{relationshipId}

Delete a relationship

https://developer.quickbase.com/operation/deleteRelationship

Parameters

  • tableId (string, required): The unique identifier (dbid) of the table. This will be the child table.
  • relationshipId (number, required): The relationship id. This is the field id of the reference field on the child table.

Returns

DeleteRelationship200Response

  • relationshipId (number, required): The relationship id.

getTableReports

GET /reports

Get reports for a table

https://developer.quickbase.com/operation/getTableReports

Parameters

  • tableId (string, required): The unique identifier of the table.

Returns

GetTableReports200Response

  • id (string, optional): The identifier of the report, unique to the table.
  • name (string, optional): The configured name of the report.
  • type (string, optional): The type of report in Quickbase (e.g., chart).
  • description (string, optional): The configured description of a report.
  • ownerId (number, optional): Optional, showed only for personal reports. The user ID of report owner.
  • query (object, optional): The query definition as configured in Quickbase that gets executed when the report is run.
  • properties ({ [key: string]: any; }, optional): A list of properties specific to the report type. To see a detailed description of the properties for each report type, See [Report Types.](../reportTypes)
  • usedLast (string, optional): The instant at which a report was last used.
  • usedCount (number, optional): The number of times a report has been used.

getReport

GET /reports/{reportId}

Get a report

https://developer.quickbase.com/operation/getReport

Parameters

  • tableId (string, required): The unique identifier of table.
  • reportId (string, required): The identifier of the report, unique to the table.

Returns

GetReport200Response

  • id (string, optional): The identifier of the report, unique to the table.
  • name (string, optional): The configured name of the report.
  • type (string, optional): The type of report in Quickbase (e.g., chart).
  • description (string, optional): The configured description of a report.
  • ownerId (number, optional): Optional, showed only for personal reports. The user ID of report owner.
  • query (object, optional): The query definition as configured in Quickbase that gets executed when the report is run.
  • properties ({ [key: string]: any; }, optional): A list of properties specific to the report type. To see a detailed description of the properties for each report type, See [Report Types.](../reportTypes)
  • usedLast (string, optional): The instant at which a report was last used.
  • usedCount (number, optional): The number of times a report has been used.

runReport

POST /reports/{reportId}/run

Run a report

https://developer.quickbase.com/operation/runReport

Parameters

  • tableId (string, required): The identifier of the table for the report.
  • skip (number, optional): The number of records to skip. You can set this value when paginating through a set of results.
  • top (number, optional): 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.
  • reportId (string, required): The identifier of the report, unique to the table.
  • body (any, optional): No description

Returns

RunReport200Response

  • fields (any, optional): 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 (any, optional): An array of objects that either represents the record data or summarized values, depending on the report type.
  • metadata (object, optional): 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.

getFields

GET /fields

Get fields for a table

https://developer.quickbase.com/operation/getFields

Parameters

  • tableId (string, required): The unique identifier (dbid) of the table.
  • includeFieldPerms (boolean, optional): Set to 'true' if you'd like to get back the custom permissions for the field(s).

Returns

GetFields200Response

  • id (number, required): The id of the field, unique to this table.
  • fieldType (string, optional): The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html).
  • mode (string, optional): 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 (string, optional): The label (name) of the field.
  • noWrap (boolean, optional): Indicates if the field is configured to not wrap when displayed in the product.
  • bold (boolean, optional): Indicates if the field is configured to display in bold in the product.
  • required (boolean, optional): Indicates if the field is marked required.
  • appearsByDefault (boolean, optional): Indicates if the field is marked as a default in reports.
  • findEnabled (boolean, optional): Indicates if the field is marked as searchable.
  • unique (boolean, optional): Indicates if the field is marked unique.
  • doesDataCopy (boolean, optional): Indicates if the field data will copy when a user copies the record.
  • fieldHelp (string, optional): The configured help text shown to users within the product.
  • audited (boolean, optional): Indicates if the field is being tracked as part of Quickbase Audit Logs.
  • properties ({ [key: string]: any; }, optional): Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type.
  • permissions (Permission[], optional): Field Permissions for different roles.
    • role (string, required): The role name
    • permissionType (string, required): Permission type (e.g., View, Modify)
    • roleId (number, required): The role identifier

createField

POST /fields

Create a field

https://developer.quickbase.com/operation/createField

Parameters

  • tableId (string, required): The unique identifier of the table.
  • body (CreateFieldRequest, optional): No description
    • label (string, required): The label of the field
    • fieldType (CreateFieldRequestFieldTypeEnum, required): The type of the field
    • fieldHelp (string, optional): Help text for the field
    • addToForms (boolean, optional): Whether to add the field to forms
    • permissions (object, optional): Custom permissions for the field
    • required (boolean, optional): Whether the field is required
    • unique (boolean, optional): Whether the field must have unique values
    • noWrap (boolean, optional): Whether text wrapping is disabled
    • bold (boolean, optional): Whether the field is bolded
    • appearsByDefault (boolean, optional): Whether the field appears by default in reports
    • findEnabled (boolean, optional): Whether the field is searchable
    • doesDataCopy (boolean, optional): Whether the field copies data
    • audited (boolean, optional): Whether changes to the field are audited
    • properties (CreateFieldRequestProperties, optional): No description

Returns

CreateField200Response

  • id (number, required): The id of the field, unique to this table.
  • fieldType (string, optional): The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html).
  • mode (string, optional): 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 (string, optional): The label (name) of the field.
  • noWrap (boolean, optional): Indicates if the field is configured to not wrap when displayed in the product.
  • bold (boolean, optional): Indicates if the field is configured to display in bold in the product.
  • required (boolean, optional): Indicates if the field is marked required.
  • appearsByDefault (boolean, optional): Indicates if the field is marked as a default in reports.
  • findEnabled (boolean, optional): Indicates if the field is marked as searchable.
  • unique (boolean, optional): Indicates if the field is marked unique.
  • doesDataCopy (boolean, optional): Indicates if the field data will copy when a user copies the record.
  • fieldHelp (string, optional): The configured help text shown to users within the product.
  • audited (boolean, optional): Indicates if the field is being tracked as part of Quickbase Audit Logs.
  • properties ({ [key: string]: any; }, optional): Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type.
  • permissions (Permission[], optional): Field Permissions for different roles.
    • role (string, required): The role name
    • permissionType (string, required): Permission type (e.g., View, Modify)
    • roleId (number, required): The role identifier

deleteFields

DELETE /fields

Delete field(s)

https://developer.quickbase.com/operation/deleteFields

Parameters

  • tableId (string, required): The unique identifier of the table.
  • body (DeleteFieldsRequest, optional): No description
    • fieldIds (number[], required): No description

Returns

DeleteFields200Response

  • deletedFieldIds (any, required): List of field ids to were deleted.
  • errors (any, required): List of errors found.

getField

GET /fields/{fieldId}

Get field

https://developer.quickbase.com/operation/getField

Parameters

  • tableId (string, required): The unique identifier (dbid) of the table.
  • includeFieldPerms (boolean, optional): Set to 'true' if you'd like to get back the custom permissions for the field(s).
  • fieldId (number, required): The unique identifier (fid) of the field.

Returns

GetField200Response

  • id (number, required): The id of the field, unique to this table.
  • fieldType (string, optional): The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html).
  • mode (string, optional): 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 (string, optional): The label (name) of the field.
  • noWrap (boolean, optional): Indicates if the field is configured to not wrap when displayed in the product.
  • bold (boolean, optional): Indicates if the field is configured to display in bold in the product.
  • required (boolean, optional): Indicates if the field is marked required.
  • appearsByDefault (boolean, optional): Indicates if the field is marked as a default in reports.
  • findEnabled (boolean, optional): Indicates if the field is marked as searchable.
  • unique (boolean, optional): Indicates if the field is marked unique.
  • doesDataCopy (boolean, optional): Indicates if the field data will copy when a user copies the record.
  • fieldHelp (string, optional): The configured help text shown to users within the product.
  • audited (boolean, optional): Indicates if the field is being tracked as part of Quickbase Audit Logs.
  • properties ({ [key: string]: any; }, optional): Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type.
  • permissions (Permission[], optional): Field Permissions for different roles.
    • role (string, required): The role name
    • permissionType (string, required): Permission type (e.g., View, Modify)
    • roleId (number, required): The role identifier

updateField

POST /fields/{fieldId}

Update a field

https://developer.quickbase.com/operation/updateField

Parameters

  • tableId (string, required): The unique identifier of the table.
  • fieldId (number, required): The unique identifier (fid) of the field.
  • body (UpdateFieldRequest, optional): No description
    • label (string, required): The label of the field
    • fieldType (UpdateFieldRequestFieldTypeEnum, optional): The type of the field
    • fieldHelp (string, optional): Help text for the field
    • addToForms (boolean, optional): Whether to add the field to forms
    • permissions (object, optional): Custom permissions for the field
    • required (boolean, optional): Whether the field is required
    • unique (boolean, optional): Whether the field must have unique values
    • noWrap (boolean, optional): Whether text wrapping is disabled
    • bold (boolean, optional): Whether the field is bolded
    • appearsByDefault (boolean, optional): Whether the field appears by default in reports
    • findEnabled (boolean, optional): Whether the field is searchable
    • doesDataCopy (boolean, optional): Whether the field copies data
    • audited (boolean, optional): Whether changes to the field are audited
    • properties (CreateFieldRequestProperties, optional): No description

Returns

UpdateField200Response

  • id (number, required): The id of the field, unique to this table.
  • fieldType (string, optional): The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html).
  • mode (string, optional): 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 (string, optional): The label (name) of the field.
  • noWrap (boolean, optional): Indicates if the field is configured to not wrap when displayed in the product.
  • bold (boolean, optional): Indicates if the field is configured to display in bold in the product.
  • required (boolean, optional): Indicates if the field is marked required.
  • appearsByDefault (boolean, optional): Indicates if the field is marked as a default in reports.
  • findEnabled (boolean, optional): Indicates if the field is marked as searchable.
  • unique (boolean, optional): Indicates if the field is marked unique.
  • doesDataCopy (boolean, optional): Indicates if the field data will copy when a user copies the record.
  • fieldHelp (string, optional): The configured help text shown to users within the product.
  • audited (boolean, optional): Indicates if the field is being tracked as part of Quickbase Audit Logs.
  • properties ({ [key: string]: any; }, optional): Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type.
  • permissions (Permission[], optional): Field Permissions for different roles.
    • role (string, required): The role name
    • permissionType (string, required): Permission type (e.g., View, Modify)
    • roleId (number, required): The role identifier

getFieldsUsage

GET /fields/usage

Get usage for all fields

https://developer.quickbase.com/operation/getFieldsUsage

Parameters

  • tableId (string, required): The unique identifier (dbid) of the table.
  • skip (number, optional): The number of fields to skip from the list.
  • top (number, optional): The maximum number of fields to return.

Returns

GetFieldsUsage200Response

  • field (object, required): Basic information about the field.
  • usage (object, required): Usage Information about the field.

getFieldUsage

GET /fields/usage/{fieldId}

Get usage for a field

https://developer.quickbase.com/operation/getFieldUsage

Parameters

  • tableId (string, required): The unique identifier (dbid) of the table.
  • fieldId (number, required): The unique identifier (fid) of the field.

Returns

GetFieldUsage200Response

  • field (object, required): Basic information about the field.
  • usage (object, required): Usage Information about the field.

runFormula

POST /formula/run

Run a formula

https://developer.quickbase.com/operation/runFormula

Parameters

  • body ({ formula?: string; rid?: number; from?: string }, optional): No description

Returns

RunFormula200Response

  • result (string, optional): The formula execution result.

upsert

POST /records

Insert/Update record(s)

https://developer.quickbase.com/operation/upsert

Parameters

  • body (UpsertRequest, optional): No description
    • data (Record[], optional): No description
    • to (string, optional): No description
    • fieldsToReturn (number[], optional): No description

Returns

Upsert200Response | Upsert207Response

  • metadata (object, optional): Information about created records, updated records, referenced but unchanged records, and records having any errors while being processed.
  • data (any, optional): The data that is expected to be returned.
  • metadata ({ [key: string]: any; }, optional): Information about created records, updated records, referenced but unchanged records, and records having any errors while being processed.
  • data (string[], optional): The data that is expected to be returned.

deleteRecords

DELETE /records

Delete record(s)

https://developer.quickbase.com/operation/deleteRecords

Parameters

  • body (DeleteRecordsRequest, optional): No description
    • from (string, required): No description
    • where (string, optional): No description

Returns

DeleteRecords200Response

  • numberDeleted (number, optional): The number of records deleted.

runQuery

POST /records/query

Query for data

https://developer.quickbase.com/operation/runQuery

Parameters

  • body (RunQueryRequest, optional): No description
    • from (string, required): The table identifier.
    • select (number[], optional): An array of field ids...
    • where (string, optional): The filter, using the Quickbase query language...
    • sortBy (RunQueryRequestSortByInner[], optional): An array of field IDs and sort directions...
    • groupBy (RunQueryRequestGroupByInner[], optional): An array that contains the fields to group the records by.
    • options (RunQueryRequestOptions, optional): No description

Returns

RunQuery200Response

  • fields (any, optional): 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 (any, optional): An array of objects that either represents the record data or summarized values, depending on the report type.
  • metadata (object, optional): 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.

getTempTokenDBID

GET /auth/temporary/{dbid}

Get a temporary token for a dbid

https://developer.quickbase.com/operation/getTempTokenDBID

Parameters

  • dbid (string, required): The unique identifier of an app or table.
  • qBAppToken (string, optional): Your Quickbase app token

Returns

GetTempTokenDBID200Response

  • temporaryAuthorization (string, optional): Temporary authorization token.

exchangeSsoToken

POST /auth/oauth/token

Exchange an SSO token

https://developer.quickbase.com/operation/exchangeSsoToken

Parameters

  • body ({ grant_type?: string; requested_token_type?: string; subject_token?: string; subject_token_type?: string }, optional): No description

Returns

ExchangeSsoToken200Response

  • access_token (string, optional): The security token issued by the authorization server in response to the token exchange request. The identifier `access_token` is used for historical reasons and the issued token need not be an OAuth access token.
  • issued_token_type (string, optional): An identifier for the representation of the issued security token.
  • token_type (string, optional): Will always return `N_A`

cloneUserToken

POST /usertoken/clone

Clone a user token

https://developer.quickbase.com/operation/cloneUserToken

Parameters

  • body ({ name?: string; description?: string }, optional): No description

Returns

CloneUserToken200Response

  • active (boolean, optional): Whether the user token is active.
  • apps (any, optional): The list of apps this user token is assigned to.
  • lastUsed (string, optional): 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 (string, optional): User Token description.
  • id (number, optional): User Token id.
  • name (string, optional): User Token name.
  • token (string, optional): User Token value.

transferUserToken

POST /usertoken/transfer

Transfer a user token

https://developer.quickbase.com/operation/transferUserToken

Parameters

  • body ({ id?: number; from?: string; to?: string }, optional): No description

Returns

TransferUserToken200Response

  • active (boolean, optional): Whether the user token is active.
  • apps (any, optional): The list of apps this user token is assigned to.
  • lastUsed (string, optional): 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 (string, optional): User Token description.
  • id (number, optional): User Token id.
  • name (string, optional): User Token name.

deactivateUserToken

POST /usertoken/deactivate

Deactivate a user token

https://developer.quickbase.com/operation/deactivateUserToken

Returns

DeactivateUserToken200Response

  • id (number, optional): The user token id.

deleteUserToken

DELETE /usertoken

Delete a user token

https://developer.quickbase.com/operation/deleteUserToken

Returns

DeleteUserToken200Response

  • id (number, optional): The user token id.

downloadFile

GET /files/{tableId}/{recordId}/{fieldId}/{versionNumber}

Download file

https://developer.quickbase.com/operation/downloadFile

Parameters

  • tableId (string, required): The unique identifier of the table.
  • recordId (number, required): The unique identifier of the record.
  • fieldId (number, required): The unique identifier of the field.
  • versionNumber (number, required): The file attachment version number.

Returns

DownloadFile200Response

  • data (string, optional): No description

deleteFile

DELETE /files/{tableId}/{recordId}/{fieldId}/{versionNumber}

Delete file

https://developer.quickbase.com/operation/deleteFile

Parameters

  • tableId (string, required): The unique identifier of the table.
  • recordId (number, required): The unique identifier of the record.
  • fieldId (number, required): The unique identifier of the field.
  • versionNumber (number, required): The file attachment version number.

Returns

DeleteFile200Response

  • versionNumber (number, optional): The number of deleted version.
  • fileName (string, optional): The name of file associated with deleted version.
  • uploaded (string, optional): The timestamp when the version was originally uploaded.
  • creator (object, optional): The user that uploaded version.

getUsers

POST /users

Get users

https://developer.quickbase.com/operation/getUsers

Parameters

  • accountId (number, optional): The account id being used to get users. If no value is specified, the first account associated with the requesting user token is chosen.
  • body (GetUsersRequest, optional): No description
    • userIds (string[], required): No description

Returns

GetUsers200Response

  • users (any, required): A list of users found in an account with the given criterias
  • metadata (object, required): Additional request information

denyUsers

PUT /users/deny

Deny users

https://developer.quickbase.com/operation/denyUsers

Parameters

  • accountId (number, optional): The account id being used to deny users. If no value is specified, the first account associated with the requesting user token is chosen.
  • body (DenyUsersRequest, optional): No description
    • userIds (string[], required): No description

Returns

DenyUsers200Response

  • failure (any, required): A list of users that couldn't be denied. This also includes the ID's of users that are not valid.
  • success (any, required): A list of users that have successfully been denied.

denyUsersAndGroups

PUT /users/deny/{shouldDeleteFromGroups}

Deny and remove users from groups

https://developer.quickbase.com/operation/denyUsersAndGroups

Parameters

  • accountId (number, optional): The account id being used to deny users. If no value is specified, the first account associated with the requesting user token is chosen.
  • shouldDeleteFromGroups (boolean, required): Specifies if the users should also be removed from all groups.
  • body (DenyUsersAndGroupsRequest, optional): No description
    • userIds (string[], required): No description

Returns

DenyUsersAndGroups200Response

  • failure (any, required): A list of users that couldn't be denied. This also includes the ID's of users that are not valid.
  • success (any, required): A list of users that have successfully been denied.

undenyUsers

PUT /users/undeny

Undeny users

https://developer.quickbase.com/operation/undenyUsers

Parameters

  • accountId (number, optional): The account id being used to undeny users. If no value is specified, the first account associated with the requesting user token is chosen.
  • body (UndenyUsersRequest, optional): No description
    • userIds (string[], required): No description

Returns

UndenyUsers200Response

  • failure (any, required): A list of users that couldn't be undenied. This also includes the ID's of users that are not valid.
  • success (any, required): A list of users that have successfully been undenied.

addMembersToGroup

POST /groups/{gid}/members

Add members

https://developer.quickbase.com/operation/addMembersToGroup

Parameters

  • gid (number, required): This is the ID of the group being modified.
  • body (AddMembersToGroupRequest, optional): No description
    • userIds (string[], required): No description

Returns

AddMembersToGroup200Response

  • failure (any, required): A list of users that couldn’t be added to the group. This includes a list of IDs that represent invalid users and users who have already been added to the group.
  • success (any, required): A list of users that have been added to the group successfully.

removeMembersFromGroup

DELETE /groups/{gid}/members

Remove members

https://developer.quickbase.com/operation/removeMembersFromGroup

Parameters

  • gid (number, required): This is the ID of the group being modified.
  • body (RemoveMembersFromGroupRequest, optional): No description
    • userIds (string[], required): No description

Returns

RemoveMembersFromGroup200Response

  • failure (any, required): A list of users that couldn’t be removed from the group. This includes a list of IDs that represent invalid users.
  • success (any, required): A list of users that have been removed from the group successfully.

addManagersToGroup

POST /groups/{gid}/managers

Add managers

https://developer.quickbase.com/operation/addManagersToGroup

Parameters

  • gid (number, required): This is the ID of the group being modified.
  • body (AddManagersToGroupRequest, optional): No description
    • userIds (string[], required): No description

Returns

AddManagersToGroup200Response

  • failure (any, required): A list of users that couldn’t be added to the group. This includes a list of IDs that represent invalid users and users who have already been added to the group.
  • success (any, required): A list of users that have been added to the group successfully.

removeManagersFromGroup

DELETE /groups/{gid}/managers

Remove managers

https://developer.quickbase.com/operation/removeManagersFromGroup

Parameters

  • gid (number, required): This is the ID of the group being modified.
  • body (RemoveManagersFromGroupRequest, optional): No description
    • userIds (string[], required): No description

Returns

RemoveManagersFromGroup200Response

  • failure (any, required): A list of users that couldn’t be removed from the group. This includes a list of IDs that represent invalid users.
  • success (any, required): A list of users that have been removed from the group successfully.

addSubgroupsToGroup

POST /groups/{gid}/subgroups

Add child groups

https://developer.quickbase.com/operation/addSubgroupsToGroup

Parameters

  • gid (number, required): This is the ID of the group being modified.
  • body (AddSubgroupsToGroupRequest, optional): No description
    • userIds (string[], required): No description

Returns

AddSubgroupsToGroup200Response

  • failure (any, required): A list of child groups that couldn’t be added to the group. This includes a list of IDs that represent invalid groups and groups that have already been added to the group.
  • success (any, required): A list of child groups that have been added to the group successfully.

removeSubgroupsFromGroup

DELETE /groups/{gid}/subgroups

Remove child groups

https://developer.quickbase.com/operation/removeSubgroupsFromGroup

Parameters

  • gid (number, required): This is the ID of the group being modified.
  • body (RemoveSubgroupsFromGroupRequest, optional): No description
    • userIds (string[], required): No description

Returns

RemoveSubgroupsFromGroup200Response

  • failure (any, required): A list of child groups that couldn’t be removed from the group. This includes a list of IDs that represent invalid groups.
  • success (any, required): A list of child groups that have been removed from the group successfully.

audit

POST /audit

Get audit logs

https://developer.quickbase.com/operation/audit

Parameters

  • body ({ nextToken?: string; numRows?: number; queryId?: string; date?: string; topics?: string[] }, optional): No description

Returns

Audit200Response

  • queryId (string, required): Query id of the requested audit log.
  • events (any, optional): All events of the audit log.
  • nextToken (string, optional): Token to fetch the next 1000 logs.

platformAnalyticReads

GET /analytics/reads

Get read summaries

https://developer.quickbase.com/operation/platformAnalyticReads

Parameters

  • day (string, optional): The date for which read summaries need to be fetched. This must be date-time only, as YYYY-MM-DD, and a valid date in the past.

Returns

PlatformAnalyticReads200Response

  • date (string, required): The date of the requested summary.
  • reads (object, required): Total reads for the specified date.

platformAnalyticEventSummaries

POST /analytics/events/summaries

Get event summaries

https://developer.quickbase.com/operation/platformAnalyticEventSummaries

Parameters

  • accountId (number, optional): The ID of the account to query. If no value is specified, the first account matching the provided domain is chosen.
  • body ({ start?: string; end?: string; groupBy?: string; nextToken?: string; where?: { id?: string; type?: string }[] }, optional): No description

Returns

PlatformAnalyticEventSummaries200Response

  • accountId (string, required): The ID of the account the events are associated with.
  • start (string, required): The start date and time of the requested summaries in ISO 8601 time format.
  • end (string, required): The end date and time of the requested summaries in ISO 8601 time format.
  • groupBy (string, required): How the events should be grouped.
  • where (any, required): No description
  • results (any, required): An array of objects that contains Application/User information and an events object with summaries by event type.
  • metadata (object, optional): Additional information about the results that may be helpful.
  • totals (object, optional): Totals by billing category for all queried events.

exportSolution

GET /solutions/{solutionId}

Export a solution

https://developer.quickbase.com/operation/exportSolution

Parameters

  • solutionId (string, required): The unique identifier of a solution
  • qBLVersion (string, optional): The QBL version to be used for the export. If not specified the default would be used.

Returns

ExportSolution200Response

  • content (string, optional): No description

updateSolution

PUT /solutions/{solutionId}

Update a solution

https://developer.quickbase.com/operation/updateSolution

Parameters

  • solutionId (string, required): The unique identifier of a solution
  • body (any, optional): The QBL to be used for the update.
  • xQBLErrorsAsSuccess (boolean, optional): If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.

Returns

UpdateSolution200Response

  • solutionId (string, optional): No description
  • alias (object, optional): No description
  • createdResources (any, optional): No description
  • warnings (any, optional): No description

createSolution

POST /solutions

Create a solution

https://developer.quickbase.com/operation/createSolution

Parameters

  • body (any, optional): The QBL to be used for the create.
  • xQBLErrorsAsSuccess (boolean, optional): If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.

Returns

CreateSolution200Response

  • solutionId (string, optional): No description
  • alias (object, optional): No description
  • createdResources (any, optional): No description
  • warnings (any, optional): No description

exportSolutionToRecord

GET /solutions/{solutionId}/torecord

Export solution to record

https://developer.quickbase.com/operation/exportSolutionToRecord

Parameters

  • solutionId (string, required): The unique identifier of the solution.
  • tableId (string, required): The unique identifier (dbid) of the table.
  • fieldId (number, required): The unique identifier (fid) of the field. It needs to be a file attachment field.
  • xQBLErrorsAsSuccess (boolean, optional): If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.
  • qBLVersion (string, optional): The QBL version to be used for the export. If not specified the default would be used.

Returns

ExportSolutionToRecord200Response

  • record_id (number, optional): No description
  • filename (string, optional): No description

createSolutionFromRecord

GET /solutions/fromrecord

Create solution from record

https://developer.quickbase.com/operation/createSolutionFromRecord

Parameters

  • tableId (string, required): The unique identifier (dbid) of the table.
  • fieldId (number, required): The unique identifier (fid) of the field. It needs to be a file attachment field.
  • recordId (number, required): The unique identifier of the record.
  • xQBLErrorsAsSuccess (boolean, optional): If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.

Returns

CreateSolutionFromRecord200Response

  • solutionId (string, optional): No description
  • alias (object, optional): No description
  • createdResources (any, optional): No description
  • warnings (any, optional): No description

updateSolutionToRecord

GET /solutions/{solutionId}/fromrecord

Update solution from record

https://developer.quickbase.com/operation/updateSolutionToRecord

Parameters

  • solutionId (string, required): The unique identifier of the solution.
  • tableId (string, required): The unique identifier (dbid) of the table.
  • fieldId (number, required): The unique identifier (fid) of the field. It needs to be a file attachment field.
  • recordId (number, required): The unique identifier of the record.
  • xQBLErrorsAsSuccess (boolean, optional): If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.

Returns

UpdateSolutionToRecord200Response

  • solutionId (string, optional): No description
  • alias (object, optional): No description
  • resources (any, optional): No description
  • warnings (any, optional): No description

changesetSolution

PUT /solutions/{solutionId}/changeset

List solution changes

https://developer.quickbase.com/operation/changesetSolution

Parameters

  • solutionId (string, required): The unique identifier of the solution.
  • body (any, optional): The QBL to be used for the changeset.
  • xQBLErrorsAsSuccess (boolean, optional): If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.

Returns

ChangesetSolution200Response

  • id (string, optional): No description
  • changes (any, optional): No description

changesetSolutionFromRecord

GET /solutions/{solutionId}/changeset/fromrecord

List solution changes from record

https://developer.quickbase.com/operation/changesetSolutionFromRecord

Parameters

  • solutionId (string, required): The unique identifier of the solution.
  • tableId (string, required): The unique identifier (dbid) of the table.
  • fieldId (number, required): The unique identifier (fid) of the field. It needs to be a file attachment field.
  • recordId (number, required): The unique identifier of the record.
  • xQBLErrorsAsSuccess (boolean, optional): If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.

Returns

ChangesetSolutionFromRecord200Response

  • id (string, optional): No description
  • changes (any, optional): No description

generateDocument

GET /docTemplates/{templateId}/generate

Generate a document

https://developer.quickbase.com/operation/generateDocument

Parameters

  • templateId (number, required): This is the ID of document template.
  • tableId (string, required): The unique identifier of the table.
  • recordId (number, optional): The ID of the record
  • filename (string, required): File name for the downloaded file
  • accept (string, optional): The content-type of the response. application/json will return a JSON payload with a base64 encoded file. application/octet-stream will download the file directly.
  • format (string, optional): The format of the file that is returned. Default is "pdf".
  • margin (string, optional): Margin formatted as top right bottom left, separated by spaces. Add to override the value set in the template builder.
  • unit (string, optional): Unit of measurement for the margin. Default is "in". Add to override the value set in the template builder.
  • pageSize (string, optional): Page size. Default is "A4". Add to override the value set in the template builder.
  • orientation (string, optional): Page orientation. Default is "portrait". Add to override the value set in the template builder.
  • realm (string, optional): Your Quickbase domain, for example demo.quickbase.com

Returns

GenerateDocument200Response

  • fileName (string, optional): The file name.
  • data (string, optional): Base64 encoded file content.
  • contentType (string, optional): The document content type.