Quickbase API Call Reference

Prev Next
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. The following table groups the API calls under different functional categories.
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_AddField to add a new field to a table. You invoke this call on a table-level dbid. When you add a field using A...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_AddGroupToRole to add a group to a role in an app. Request parameters Response values Sample XML...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_AddRecord to add a record to a table. You invoke this call on a table dbid. When you use this call, you add field...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_AddReplaceDBPage to add a new database page or replace an existing page with a new page. You invoke this call on ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_AddSubGroup to embed a group into another group. Request parameters Response values Sample XML R...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_AddUserToGroup to add a user to a group. The user can be added as a member of the group, as a member and a manage...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_AddUserToRole to assign a user to a role in your Quickbase application. You assign a user to a role using API_Ad...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_Authenticate to validate a user's username and password. You invoke this call on /db/main (no dbid). API_Authent...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_ChangeGroupInfo to modify the metadata for a group. One or more elements can be modified. Request parameters ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_ChangeManager to assign a user to manage an app. Request parameters Response values Sample XML R...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_ChangeRecordOwner to change the owner of a record. In Quickbase, a person who creates a record is the record own...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_ChangeUserRole to assign a user to a new role, to upgrade or downgrade access, or simply to move the user to a di...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_CloneDatabase to make a copy of a Quickbase application. You can choose to use the keepData parameter if y...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_CopyGroup to duplicate an existing group with the same list of users and subgroups, and a different name and ID. ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_CopyMasterDetail to copy a master record with its detail records, or to import only the detail records from one mas...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_CreateDatabase to create a new Quickbase application. Quickbase creates the main application table populated only...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_CreateGroup to create a new group. The group will be created with the caller as the group owner and the caller wi...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_CreateTable to create a table for an application. You must have application administration rights to use this cal...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_DeleteDatabase to delete a table or an entire application. Supply an application-level dbid to delete an applicat...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_DeleteField to delete a field by specifying the field id (fid). You invoke this call on a table-level dbid. (If y...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_DeleteGroup to delete a group. Caution: Use this call with care. Once a group has been deleted it cannot be re...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_DeleteRecord to delete a single record from a table.  You invoke this call on a table-level dbid. If you use...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview You invoke this call against a table dbid using a query string to determine the number of records that will be returned. ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_EditRecord to change any editable field values in the specified record. Only those fields specified are changed; ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use this call to add new choices to a text - multiple choice or multi-select text field in a Quickbase table. Note:&nbs...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use this call this to remove one or more of the options listed within a Text - Multiple Choice or Multi-select Text field...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_FindDBByName to find the application-level dbid of an application whose name you know. When you use this call, Qu...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GenAddRecordForm to return the standard Quickbase Add record  page for the table whose dbid you specify. ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GenResultsTable to embed a Quickbase table report in an HTML page. This call is typically used in its URL form e...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview This call must be invoked on the app dbid (not on a table dbid) to get ancestor information about the current application...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetAppDTMInfo to get  the timestamp of the last time change throughout the application. This is a fast, unobt...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetDBInfo to get metadata information, such as the last time the table was modified. For example, you might use t...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetDBPage to retrieve a stored page in Quickbase. Quickbase allows you to store various types of pages, ranging f...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetDBVar to get values assigned to variables (DBVars) set up in your Quickbase application. DBVars are variables ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetFieldProperties to view the properties of a field. Returns properties specific to the field type. It uses a...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetGroupRole determine the roleid for a group within an application. Request parameters Response values...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetNumRecords to get the total number of records in the table. Invoke this call on a table-level dbid. Request...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetRecordAsHTML to get a record within an HTML fragment that can be embedded in another Web page. Request para...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetRecordInfo to get the values and types of all the fields in a record. You invoke this call on a table-level db...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetRoleInfo to get all of the roles that apply to the application. You invoke this call on the application-level ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetSchema to get information about the specified application or application table. When invoked on an applicatio...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetUserInfo to get the username and user ID associated with an email address used for Quickbase sign in. You invo...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetUserRole to see what roles are assigned to a specific user in an application. Invoke this call on an applicati...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GetUsersInGroup to get the list of users and groups that make up the members and/or managers of a group. Reque...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GrantedDBs to get a list of the names and dbids of all the applications and tables that you are entitled to acces...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GrantedDBsForGroup to get a list of all the applications that a group can access. Request parameters Re...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_GrantedGroups to get the list of groups to which a user has been granted access. If the adminOnly flag is passed,...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_ImportFromCSV to add or update several records. You can also import into lookup fields to link related data. You ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_ProvisionUser to add a user who is not yet registered with Quickbase to your application. You invoke an applicati...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_PurgeRecords to delete the specified records from the specified table. All records matching the criteria in the s...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_RemoveGroupFromRole to remove a group from a role in an app. You can also indicate if you want to remove a group ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_RemoveSubgroup to remove a nested group from a group. Request parameters Response values Sample ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_RemoveUserFromGroup to remove a user from a group. Request parameters Response values Sample XML...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_RemoveUserFromRole to remove a user from a specified role. You invoke this call on an application-level dbid. If ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_RenameApp to change an application's name. You invoke this call on an application-level dbid. You must have full ...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Quickbase allows you to import data from one or more of your application tables into another application table. You can i...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_SendInvitation to send an email invitation to your application. You can send an email invitation to either an exi...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_SetDBVar to create a database variable (DBVar) or set a value for it. If the DBVar already exists, this call over...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_SetFieldProperties to set one or more properties of a field. You invoke this on a table-level dbid. Typical...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_SetKeyField to specify a field in the table as the key field. You invoke this call on a table dbid. You must have...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview This call is for use by API client implementations that make use of the ticket cookie rather than the
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_UploadFile to upload base64-encoded file attachments in Quickbase. Attachments must be base-64 encoded before upl...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_UserRoles to get details about an application’s users and their roles. This call returns all users and their role...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_Webhooks_Activate to make a webhook active. Request Parameters Response values Sample XML Reques...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_Webhooks_Copy to make a duplicate of an existing webhook. Request Parameters Response values Sam...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_Webhooks_Create to set up and configure a webhook. Request Parameters Response values Sample XML...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_Webhooks_Deactivate to disable a webhook. To reactivate a webhook, use API_Webhook_Activate . Request Paramet...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_Webhooks_Delete to delete a webhook. Request Parameters Response values Sample XML Request POS...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. Overview Use API_Webhooks_Edit to edit webhooks. Request Parameters Response values Sample XML Request POST htt...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. The documentation for each API call lists the parameters you can use with each call. Some parameters can be used with many calls. The...
Don't forget to check out our JSON RESTful APIs , they can help you utilize and extend Quickbase with ease. The Quickbase API can be invoked in either of two ways. As an XML request string POSTed to Quickbase As a URL sent in a GET req...