Table of Contents

 

Welcome to the Quick Base API Guide
Before you begin: User setup
Authentication and secure access
About user tokens
Understanding the API Reference
Common optional parameters
API call reference by function
API_AddField
API_AddGroupToRole
API_AddRecord
API_AddReplaceDBPage
API_AddSubGroup
API_AddUserToGroup
API_AddUserToRole
API_Authenticate
API_ChangeGroupInfo
API_ChangeManager
API_ChangeRecordOwner
API_ChangeUserRole
API_CloneDatabase
API_CopyGroup
API_CopyMasterDetail
API_CreateDatabase
API_CreateGroup
API_CreateTable
API_DeleteDatabase
API_DeleteField
API_DeleteGroup
API_DeleteRecord
API_DoQuery
Understanding relative date ranges
API_DoQueryCount
API_EditRecord
API_FieldAddChoices
API_FieldRemoveChoices
API_FindDBByName
API_GenAddRecordForm
API_GenResultsTable
API_GetAncestorInfo
API_GetAppDTMInfo
API_GetDBInfo
API_GetDBPage
API_GetDBVar
API_GetFieldProperties
API_GetGroupRole
API_GetNumRecords
API_GetRecordAsHTML
API_GetRecordInfo
API_GetRoleInfo
API_GetSchema
API_GetUserInfo
API_GetUserRole
API_GetUsersInGroup
API_GrantedDBs
API_GrantedDBsForGroup
API_GrantedGroups
API_ImportFromCSV
API_ProvisionUser
API_PurgeRecords
API_RemoveGroupFromRole
API_RemoveSubgroup
API_RemoveUserFromGroup
API_RemoveUserFromRole
API_RenameApp
API_RunImport
API_SendInvitation
API_SetDBVar
API_SetFieldProperties
API_SetKeyField
API_SignOut
API_UploadFile
API_UserRoles
API_Webhooks_Activate
API_Webhooks_Copy
API_Webhooks_Create
API_Webhooks_Delete
API_Webhooks_Deactivate
API_Webhooks_Edit
Using API endpoints for SCIM provisioning
Setting up a user and user token for SCIM provisioning
SCIM API endpoint details and syntax for users
SCIM API endpoint details and syntax for groups
Restrictions using the SCIM API
Troubleshooting IdM provisioning
Appendix A: Error Codes
Appendix B: Managing Files
Appendix C: Building and Using Queries
Components of a query
Sample queries
Appendix D: APIs and International Use of Quick Base