openapi: 3.0.1 info: title: Quick Base API version: 1.0.0 servers: - url: https://api.quickbase.com/v1/ security: - quickbaseAuth: [] paths: /apps: post: tags: - Apps summary: Create an app description: 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. operationId: createApp parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string requestBody: content: application/json: schema: required: - name type: object properties: assignToken: type: boolean description: 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. example: false variables: type: array description: "The app variables. A maximum of 10 variables can be\ \ inserted at a time. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)" items: type: object additionalProperties: false name: type: string description: "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." securityProperties: type: object additionalProperties: false description: Application security properties. description: type: string description: "The description for the app. If this property is left\ \ out, the app description will be blank." additionalProperties: false description: "The example below shows all the properties that can be\ \ set with this request. Additional properties that you can see, with\ \ the corresponding GET request, cannot be set through this API. See\ \ individual property descriptions below for details on how to set\ \ or change each." example: value: name: My App description: My first app assignToken: true securityProperties: allowClone: false allowExport: false enableAppTokens: false hideFromPublic: false mustBeRealmApproved: true useIPFilter: true variables: - name: Variable1 value: Value1 required: false x-amf-mediaType: application/json responses: "200": description: Success content: application/json: schema: required: - name type: object properties: name: type: string description: "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: type: string description: "The description for the app. If this property is\ \ left out, the app description will be blank." created: type: string description: "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: type: string description: "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: type: string description: "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/docs/how-to-localize-dates)\ \ to set the app's date format." timeZone: type: string description: "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/docs/set-the-time-zone-for-both-the-application-and-the-account)\ \ to set the application's time zone." memoryInfo: type: object additionalProperties: false description: Application memory info id: type: string description: The unique identifier for this application. hasEveryoneOnTheInternet: type: boolean description: "Indicates whether app includes Everyone On The Internet\ \ access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/docs/sharing-apps-publicly)" variables: type: array description: "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)" items: type: object additionalProperties: true dataClassification: type: string description: "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: type: object additionalProperties: true description: Security properties of the application additionalProperties: true x-amf-examples: Simple Application: created: 2020-03-27T18:34:12Z dateFormat: MM-DD-YYYY description: My testing app hasEveryoneOnTheInternet: true id: bpqe82s1 memoryInfo: estMemory: 1 estMemoryInclDependentApps: 2 name: Testing App securityProperties: allowClone: false allowExport: false enableAppTokens: false hideFromPublic: false mustBeRealmApproved: true useIPFilter: true timeZone: (UTC-08:00) Pacific Time (US & Canada) updated: 2020-04-03T19:12:20Z dataClassification: Confidential Application with defined variables: description: This examples shows the response of an application that contains one or more variables. value: created: 2020-03-27T18:34:12Z dateFormat: MM-DD-YYYY description: My testing app hasEveryoneOnTheInternet: true id: bpqe82s1 memoryInfo: estMemory: 1 estMemoryInclDependentApps: 2 name: Testing App securityProperties: allowClone: false allowExport: false enableAppTokens: false hideFromPublic: false mustBeRealmApproved: true useIPFilter: true timeZone: (UTC-08:00) Pacific Time (US & Canada) variables: - name: Project End Date value: 7-16-2025 - name: Project Manager Email value: p.diaz@company.com updated: 2020-04-03T19:12:20Z x-amf-mediaType: application/json x-codegen-request-body-name: generated /apps/{appId}: get: tags: - Apps summary: Get an app description: "Returns the main properties of an application, including application\ \ variables." operationId: getApp parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: required: - name type: object properties: ancestorId: type: string description: The id of the app from which this app was copied name: type: string description: "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: type: string description: "The description for the app. If this property is\ \ left out, the app description will be blank." created: type: string description: "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: type: string description: "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: type: string description: "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: type: string description: "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: type: object additionalProperties: false description: Application memory info id: type: string description: The unique identifier for this application. hasEveryoneOnTheInternet: type: boolean description: "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: type: array description: "The app variables. See [About Application Variables](https://help.quickbase.com/docs/creating-and-using-application-variables)" items: type: object additionalProperties: true dataClassification: type: string description: "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: type: object additionalProperties: true description: Security properties of the application additionalProperties: true x-amf-examples: Simple Application: ancestorId: bqhskthaq created: 2020-03-27T18:34:12Z dateFormat: MM-DD-YYYY description: My testing app hasEveryoneOnTheInternet: true memoryInfo: estMemory: 1 estMemoryInclDependentApps: 2 id: bpqe82s1 name: Testing App securityProperties: allowClone: false allowExport: false enableAppTokens: false hideFromPublic: false mustBeRealmApproved: true useIPFilter: true timeZone: (UTC-08:00) Pacific Time (US & Canada) updated: 2020-04-03T19:12:20Z dataClassification: Confidential Application with defined variables: description: This examples shows the response of an application that contains one or more variables. value: ancestorId: bqhskthaq created: 2020-03-27T18:34:12Z dateFormat: MM-DD-YYYY description: My testing app hasEveryoneOnTheInternet: true id: bpqe82s1 memoryInfo: estMemory: 1 estMemoryInclDependentApps: 2 name: Testing App securityProperties: allowClone: false allowExport: false enableAppTokens: false hideFromPublic: false mustBeRealmApproved: true useIPFilter: true timeZone: (UTC-08:00) Pacific Time (US & Canada) variables: - name: Project End Date value: 7-16-2025 - name: Project Manager Email value: p.diaz@company.com updated: 2020-04-03T19:12:20Z x-amf-mediaType: application/json post: tags: - Apps summary: Update an app description: 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. operationId: updateApp parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: required: - name type: object properties: ancestorId: type: string description: The id of the app from which this app was copied name: type: string description: "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: type: string description: "The description for the app. If this property is\ \ left out, the app description will be blank." created: type: string description: "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: type: string description: "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: type: string description: "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: type: string description: "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: type: object additionalProperties: false description: Application memory info id: type: string description: The unique identifier for this application. hasEveryoneOnTheInternet: type: boolean description: "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: type: array description: "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)" items: type: object additionalProperties: true dataClassification: type: string description: "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: type: object additionalProperties: true description: Security properties of the application additionalProperties: true x-amf-examples: Simple Application: ancestorId: bqhskthaq created: 2020-03-27T18:34:12Z dateFormat: MM-DD-YYYY description: My testing app hasEveryoneOnTheInternet: true memoryInfo: estMemory: 1 estMemoryInclDependentApps: 2 id: bpqe82s1 name: Testing App securityProperties: allowClone: false allowExport: false enableAppTokens: false hideFromPublic: false mustBeRealmApproved: true useIPFilter: true timeZone: (UTC-08:00) Pacific Time (US & Canada) updated: 2020-04-03T19:12:20Z dataClassification: Confidential Application with defined variables: description: This examples shows the response of an application that contains one or more variables. value: ancestorId: bqhskthaq created: 2020-03-27T18:34:12Z dateFormat: MM-DD-YYYY description: My testing app hasEveryoneOnTheInternet: true id: bpqe82s1 memoryInfo: estMemory: 1 estMemoryInclDependentApps: 2 name: Testing App securityProperties: allowClone: false allowExport: false enableAppTokens: false hideFromPublic: false mustBeRealmApproved: true useIPFilter: true timeZone: (UTC-08:00) Pacific Time (US & Canada) variables: - name: Project End Date value: 7-16-2025 - name: Project Manager Email value: p.diaz@company.com updated: 2020-04-03T19:12:20Z x-amf-mediaType: application/json x-codegen-request-body-name: generated delete: tags: - Apps summary: Delete an app description: "Deletes an entire application, including all of the tables and\ \ data." operationId: deleteApp parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: deletedAppId: type: string description: An ID of deleted application. additionalProperties: true example: deletedAppId: bqhskthaq x-amf-mediaType: application/json x-codegen-request-body-name: generated /apps/{appId}/events: get: tags: - Apps summary: Get app events description: "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)." operationId: getAppEvents parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: array example: - type: qb-action owner: email: jsmith@quickbase.com id: 123456.ab1s name: Juliet Smith userName: jsmith isActive: true tableId: bqwriv8bw name: Quick Base Action - type: webhook owner: email: tanderson@quickbase.com id: 654321.ab1s name: Thomas A. Anderson userName: tanderson isActive: false tableId: bqwriv8bw name: Webhook - type: email-notification owner: email: jsmith@quickbase.com id: 123456.ab1s name: Juliet Smith userName: jsmith isActive: false tableId: bqwriv8bw name: Notification - type: subscription owner: email: tanderson@quickbase.com id: 654321.ab1s name: Thomas A. Anderson userName: tanderson isActive: true tableId: bqwriv8bw name: Subscription - type: reminder owner: email: jsmith@quickbase.com id: 123456.ab1s name: Juliet Smith userName: jsmith isActive: true tableId: bqwriv8bw name: Reminder - type: automation owner: email: tanderson@quickbase.com id: 654321.ab1s name: Thomas A. Anderson userName: tanderson isActive: true tableId: bqwriv8bw url: https://realm.quickbase.com/ui/automation/qb/db/bqwria893/automations/70eecab9-634f-42d9-9037-9340a1a9e8ce items: type: object additionalProperties: true x-amf-mediaType: application/json /apps/{appId}/copy: post: tags: - Apps summary: Copy an app description: Copies the specified application. The new application will have the same schema as the original. See below for additional copy options. operationId: copyApp parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: required: - name type: object properties: name: type: string description: "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: type: string description: The description for the app created: type: string description: "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: type: string description: "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: type: string description: "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: type: string description: "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: type: string description: The unique identifier for this application. hasEveryoneOnTheInternet: type: boolean description: "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: type: array description: "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)" items: type: object additionalProperties: true ancestorId: type: string description: The id of the app from which this app was copied dataClassification: type: string description: "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." additionalProperties: true example: ancestorId: bqhskthaq created: 2020-03-27T18:34:12Z dateFormat: MM-DD-YYYY description: My testing app hasEveryoneOnTheInternet: true id: bpqe82s1 name: Testing App timeZone: (UTC-08:00) Pacific Time (US & Canada) updated: 2020-04-03T19:12:20Z dataClassification: None x-amf-mediaType: application/json x-codegen-request-body-name: generated /apps/{appId}/roles: get: tags: - Apps summary: Get app roles description: Retrieves all of the roles for an application. Requires admin access to an app. operationId: getRoles parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: array example: - access: id: 3 type: Basic Access id: 10 name: Viewer - access: id: 2 type: Basic Access with Share id: 11 name: Participant items: type: object additionalProperties: true x-amf-mediaType: application/json /tables: get: tags: - Tables summary: Get tables for an app description: 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. operationId: getAppTables parameters: - name: appId in: query description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: array example: - name: "Example Table #0" created: 2020-03-27T18:34:40Z updated: 2020-04-03T19:12:40Z alias: _dbid_example_table_#0 description: Table zero as an example. id: bpqe82s1 nextRecordId: 1 nextFieldId: 1 defaultSortFieldId: 2 defaultSortOrder: ASC keyFieldId: 3 singleRecordName: Example Record pluralRecordName: Example Records sizeLimit: 150 MB spaceUsed: 17 MB spaceRemaining: 133 MB - name: "Example Table #2" created: 2020-03-27T18:34:40Z updated: 2020-04-03T19:12:40Z alias: _dbid_example_table_#2 description: Table two as an example. id: bpqe82z1 nextRecordId: 10 nextFieldId: 111 defaultSortFieldId: 12 defaultSortOrder: DESC keyFieldId: 33 singleRecordName: Another Record pluralRecordName: More Records sizeLimit: 150 MB spaceUsed: 22 MB spaceRemaining: 128 MB items: type: object additionalProperties: true example: name: Example Table created: 2020-03-27T18:34:40Z updated: 2020-04-03T19:12:40Z alias: _dbid_example_table description: Table as an example. id: bpqe82s0 nextRecordId: 1 nextFieldId: 1 defaultSortFieldId: 2 defaultSortOrder: ASC keyFieldId: 3 singleRecordName: Example Record pluralRecordName: Example Records sizeLimit: 150 MB spaceUsed: 17 MB spaceRemaining: 133 MB x-amf-mediaType: application/json post: tags: - Tables summary: Create a table description: Creates a table in an application. operationId: createTable parameters: - name: appId in: query description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: name: type: string description: The name of the table. id: type: string description: The unique identifier (dbid) of the table. alias: type: string description: The automatically-created table alias for the table. description: type: string description: "The description of the table, as configured by an\ \ application administrator." created: type: string description: "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: type: string description: "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: type: integer description: "The incremental Record ID that will be used when\ \ the next record is created, as determined when the API call\ \ was ran." nextFieldId: type: integer description: "The incremental Field ID that will be used when\ \ the next field is created, as determined when the API call\ \ was ran." defaultSortFieldId: type: integer description: The id of the field that is configured for default sorting. defaultSortOrder: type: string description: The configuration of the default sort order on the table. enum: - ASC - DESC keyFieldId: type: integer description: "The id of the field that is configured to be the\ \ key on this table, which is usually the Quickbase Record ID." singleRecordName: type: string description: The builder-configured singular noun of the table. pluralRecordName: type: string description: The builder-configured plural noun of the table. sizeLimit: type: string description: The size limit for the table. spaceUsed: type: string description: The amount of space currently being used by the table. spaceRemaining: type: string description: The amount of space remaining for use by the table. additionalProperties: true example: name: Example Table created: 2020-03-27T18:34:40Z updated: 2020-04-03T19:12:40Z alias: _dbid_example_table description: Table as an example. id: bpqe82s0 nextRecordId: 1 nextFieldId: 1 defaultSortFieldId: 2 defaultSortOrder: ASC keyFieldId: 3 singleRecordName: Example Record pluralRecordName: Example Records sizeLimit: 150 MB spaceUsed: 17 MB spaceRemaining: 133 MB x-amf-mediaType: application/json x-codegen-request-body-name: generated /tables/{tableId}: get: tags: - Tables summary: Get a table description: Gets the properties of an individual table that is part of an application. operationId: getTable parameters: - name: appId in: query description: The unique identifier of an app required: true schema: type: string - name: tableId in: path description: The unique identifier (dbid) of the table. required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: name: type: string description: The name of the table. id: type: string description: The unique identifier (dbid) of the table. alias: type: string description: The automatically-created table alias for the table. description: type: string description: "The description of the table, as configured by an\ \ application administrator." created: type: string description: "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: type: string description: "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: type: integer description: "The incremental Record ID that will be used when\ \ the next record is created, as determined when the API call\ \ was ran." nextFieldId: type: integer description: "The incremental Field ID that will be used when\ \ the next field is created, as determined when the API call\ \ was ran." defaultSortFieldId: type: integer description: The id of the field that is configured for default sorting. defaultSortOrder: type: string description: The configuration of the default sort order on the table. enum: - ASC - DESC keyFieldId: type: integer description: "The id of the field that is configured to be the\ \ key on this table, which is usually the Quickbase Record ID." singleRecordName: type: string description: The builder-configured singular noun of the table. pluralRecordName: type: string description: The builder-configured plural noun of the table. sizeLimit: type: string description: The size limit for the table. spaceUsed: type: string description: The amount of space currently being used by the table. spaceRemaining: type: string description: The amount of space remaining for use by the table. additionalProperties: true example: name: Example Table created: 2020-03-27T18:34:40Z updated: 2020-04-03T19:12:40Z alias: _dbid_example_table description: Table as an example. id: bpqe82s0 nextRecordId: 1 nextFieldId: 1 defaultSortFieldId: 2 defaultSortOrder: ASC keyFieldId: 3 singleRecordName: Example Record pluralRecordName: Example Records sizeLimit: 150 MB spaceUsed: 17 MB spaceRemaining: 133 MB x-amf-mediaType: application/json post: tags: - Tables summary: Update a table description: 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. operationId: updateTable parameters: - name: appId in: query description: The unique identifier of an app required: true schema: type: string - name: tableId in: path description: The unique identifier (dbid) of the table. required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: name: type: string description: The name of the table. id: type: string description: The unique identifier (dbid) of the table. alias: type: string description: The automatically-created table alias for the table. description: type: string description: "The description of the table, as configured by an\ \ application administrator." created: type: string description: "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: type: string description: "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: type: integer description: "The incremental Record ID that will be used when\ \ the next record is created, as determined when the API call\ \ was ran." nextFieldId: type: integer description: "The incremental Field ID that will be used when\ \ the next field is created, as determined when the API call\ \ was ran." defaultSortFieldId: type: integer description: The id of the field that is configured for default sorting. defaultSortOrder: type: string description: The configuration of the default sort order on the table. enum: - ASC - DESC keyFieldId: type: integer description: "The id of the field that is configured to be the\ \ key on this table, which is usually the Quickbase Record ID." singleRecordName: type: string description: The builder-configured singular noun of the table. pluralRecordName: type: string description: The builder-configured plural noun of the table. sizeLimit: type: string description: The size limit for the table. spaceUsed: type: string description: The amount of space currently being used by the table. spaceRemaining: type: string description: The amount of space remaining for use by the table. additionalProperties: true example: name: Example Table created: 2020-03-27T18:34:40Z updated: 2020-04-03T19:12:40Z alias: _dbid_example_table description: Table as an example. id: bpqe82s0 nextRecordId: 1 nextFieldId: 1 defaultSortFieldId: 2 defaultSortOrder: ASC keyFieldId: 3 singleRecordName: Example Record pluralRecordName: Example Records sizeLimit: 150 MB spaceUsed: 17 MB spaceRemaining: 133 MB x-amf-mediaType: application/json x-codegen-request-body-name: generated delete: tags: - Tables summary: Delete a table description: "Deletes a specific table in an application, including all of the\ \ data within it." operationId: deleteTable parameters: - name: appId in: query description: The unique identifier of an app required: true schema: type: string - name: tableId in: path description: The unique identifier (dbid) of the table. required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: deletedTableId: type: string description: The deleted table id. additionalProperties: true example: deletedTableId: bck7gp3q2 x-amf-mediaType: application/json /tables/{tableId}/relationships: get: tags: - Tables summary: Get all relationships description: "Get a list of all relationships, and their definitions, for a\ \ specific table. Details are provided for the child side of relationships\ \ within a given application. Limited details are returned for cross-application\ \ relationships." operationId: getRelationships parameters: - name: skip in: query description: The number of relationships to skip. schema: type: integer - name: tableId in: path description: The unique identifier (dbid) of the child table. required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - relationships type: object properties: relationships: type: array description: The relationships in a table. items: type: object additionalProperties: true example: id: 6 foreignKeyField: id: 6 label: Related record type: numeric lookupFields: - id: 7 label: record - text field type: text isCrossApp: false parentTableId: bck7gp3q2 childTableId: bck7gp3q3 summaryFields: - id: 8 label: Summary of Record ID#2 type: numeric metadata: type: object additionalProperties: true description: Additional information about the results that may be helpful. additionalProperties: true example: metadata: numRelationships: 1 skip: 0 totalRelationships: 1 relationships: - childTableId: bqqjnwsuy foreignKeyField: id: 6 label: Related record type: numeric id: 6 isCrossApp: false lookupFields: - id: 3 label: Name type: text parentTableId: bck7gp3q2 summaryFields: - id: 8 label: my summary field type: numeric x-amf-mediaType: application/json /tables/{tableId}/relationship: post: tags: - Tables summary: Create a relationship description: Creates a relationship in a table as well as lookup/summary fields. Relationships can only be created for tables within the same app. operationId: createRelationship parameters: - name: tableId in: path description: The unique identifier (dbid) of the table. This will be the child table. required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - childTableId - id - isCrossApp - parentTableId type: object properties: id: type: integer description: The relationship id (foreign key field id). parentTableId: type: string description: The parent table id of the relationship. childTableId: type: string description: The child table id of the relationship. foreignKeyField: type: object additionalProperties: true description: The foreign key field information. isCrossApp: type: boolean description: Whether this is a cross-app relationship. lookupFields: type: array description: The lookup fields array. items: type: object additionalProperties: true summaryFields: type: array description: The summary fields array. items: type: object additionalProperties: true additionalProperties: true example: id: 6 foreignKeyField: id: 6 label: Related record type: numeric lookupFields: - id: 7 label: record - text field type: text isCrossApp: false parentTableId: bck7gp3q2 childTableId: bck7gp3q3 summaryFields: - id: 8 label: Summary of Record ID#2 type: numeric x-amf-mediaType: application/json x-codegen-request-body-name: generated /tables/{tableId}/relationship/{relationshipId}: post: tags: - Tables summary: Update a relationship description: Use this endpoint to add lookup fields and summary fields to an existing relationship. Updating a relationship will not delete existing lookup/summary fields. operationId: updateRelationship parameters: - name: tableId in: path description: The unique identifier (dbid) of the table. This will be the child table. required: true schema: type: string - name: relationshipId in: path description: The relationship id. This is the field id of the reference field on the child table. required: true schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - childTableId - id - isCrossApp - parentTableId type: object properties: id: type: integer description: The relationship id (foreign key field id). parentTableId: type: string description: The parent table id of the relationship. childTableId: type: string description: The child table id of the relationship. foreignKeyField: type: object additionalProperties: true description: The foreign key field information. isCrossApp: type: boolean description: Whether this is a cross-app relationship. lookupFields: type: array description: The lookup fields array. items: type: object additionalProperties: true summaryFields: type: array description: The summary fields array. items: type: object additionalProperties: true additionalProperties: true example: id: 6 foreignKeyField: id: 6 label: Related record type: numeric lookupFields: - id: 7 label: record - text field type: text isCrossApp: false parentTableId: bck7gp3q2 childTableId: bck7gp3q3 summaryFields: - id: 8 label: Summary of Record ID#2 type: numeric x-amf-mediaType: application/json x-codegen-request-body-name: generated delete: tags: - Tables summary: Delete a relationship description: "Use this endpoint to delete an entire relationship, including\ \ all lookup and summary fields. The reference field in the relationship will\ \ not be deleted." operationId: deleteRelationship parameters: - name: tableId in: path description: The unique identifier (dbid) of the table. This will be the child table. required: true schema: type: string - name: relationshipId in: path description: The relationship id. This is the field id of the reference field on the child table. required: true schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - relationshipId type: object properties: relationshipId: type: integer description: The relationship id. additionalProperties: true example: relationshipId: 6 x-amf-mediaType: application/json /reports: get: tags: - Reports summary: Get reports for a table description: "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." operationId: getTableReports parameters: - name: tableId in: query description: The unique identifier of the table. required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: array description: "This is simple example of report schema for more details\ \ please refer [Report types page](../reportTypes)" items: type: object additionalProperties: true example: value: id: "5" name: table-report type: table description: This is Table report. query: tableId: bpweef42b filter: "{6.CT.'FilterByThisValue'}" formulaFields: - id: -100 label: NumericField fieldType: numeric formula: 1+1 decimalPrecision: 4 fields: - 7 sortBy: - fieldId: 28 order: ASC - fieldId: 3 order: ASC groupBy: - fieldId: 3 grouping: equal-values properties: displayOnlyNewOrChangedRecords: true columnProperties: - fieldId: -100 labelOverride: Numeric Field Label usedLast: 2020-09-20T20:23:00Z usedCount: 7 x-amf-mediaType: application/json /reports/{reportId}: get: tags: - Reports summary: Get a report description: Get the schema (properties) of an individual report. operationId: getReport parameters: - name: tableId in: query description: The unique identifier of table. required: true schema: type: string - name: reportId in: path description: "The identifier of the report, unique to the table." required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: id: type: string description: "The identifier of the report, unique to the table." name: type: string description: The configured name of the report. type: type: string description: "The type of report in Quickbase (e.g., chart)." description: type: string description: The configured description of a report. ownerId: type: integer description: "Optional, showed only for personal reports. The\ \ user ID of report owner." query: type: object additionalProperties: true description: The query definition as configured in Quickbase that gets executed when the report is run. properties: type: object additionalProperties: true description: "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: type: string description: The instant at which a report was last used. usedCount: type: integer description: The number of times a report has been used. additionalProperties: true example: value: id: "5" name: table-report type: table description: This is Table report. query: tableId: bpweef42b filter: "{6.CT.'FilterByThisValue'}" formulaFields: - id: -100 label: NumericField fieldType: numeric formula: 1+1 decimalPrecision: 4 fields: - 7 sortBy: - fieldId: 28 order: ASC - fieldId: 3 order: ASC groupBy: - fieldId: 3 grouping: equal-values properties: displayOnlyNewOrChangedRecords: true columnProperties: - fieldId: -100 labelOverride: Numeric Field Label usedLast: 2020-09-20T20:23:00Z usedCount: 7 x-amf-mediaType: application/json /reports/{reportId}/run: post: tags: - Reports summary: Run a report description: "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." operationId: runReport parameters: - name: tableId in: query description: The identifier of the table for the report. required: true schema: type: string - name: skip in: query description: The number of records to skip. You can set this value when paginating through a set of results. schema: type: integer - name: top in: query description: "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." schema: type: integer - name: reportId in: path description: "The identifier of the report, unique to the table." required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: fields: type: array description: 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. items: type: object additionalProperties: true data: type: array description: "An array of objects that either represents the record\ \ data or summarized values, depending on the report type." items: type: object metadata: type: object additionalProperties: true description: "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." additionalProperties: true example: value: data: - "6": value: Jamie Stein "7": value: 10 "8": value: 2019-12-18T08:00:00Z fields: - id: 6 label: Full Name type: text - id: 7 label: Amount labelOverride: Total Amount type: numeric - id: 8 label: Date time type: date time metadata: totalRecords: 10 numRecords: 1 numFields: 3 skip: 0 top: 1 x-amf-mediaType: application/json x-codegen-request-body-name: generated /fields: get: tags: - Fields summary: Get fields for a table description: Gets the properties for all fields in a specific table. The properties for each field are the same as in Get field. operationId: getFields parameters: - name: tableId in: query description: The unique identifier (dbid) of the table. required: true schema: type: string - name: includeFieldPerms in: query description: Set to 'true' if you'd like to get back the custom permissions for the field(s). schema: type: boolean default: false - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: array example: - id: 1 label: Field1 fieldType: text noWrap: false bold: false required: false appearsByDefault: false findEnabled: false unique: false doesDataCopy: false fieldHelp: field help audited: false properties: primaryKey: false foreignKey: false numLines: 1 maxLength: 0 appendOnly: false allowHTML: false allowMentions: false sortAsGiven: false carryChoices: true allowNewChoices: false formula: "" defaultValue: "" permissions: - permissionType: View role: Viewer roleId: 10 - permissionType: None role: Participant roleId: 11 - permissionType: Modify role: Administrator roleId: 12 - id: 2 label: Numeric Field fieldType: numeric appearsByDefault: true audited: false bold: false fieldHelp: This is a numeric field findEnabled: false addToForms: true properties: numberFormat: 3 decimalPlaces: 2 doesAverage: true doesTotal: true blankIsZero: true permissions: - role: Viewer permissionType: View roleId: 10 - role: Participant permissionType: Modify roleId: 11 - role: Administrator permissionType: Modify roleId: 12 items: type: object additionalProperties: true example: id: 123 label: Field1 fieldType: text mode: "" noWrap: false bold: false required: false appearsByDefault: false findEnabled: false unique: false doesDataCopy: false fieldHelp: field help audited: false properties: primaryKey: false foreignKey: false numLines: 1 maxLength: 0 appendOnly: false allowHTML: false allowMentions: false sortAsGiven: false carryChoices: true allowNewChoices: false formula: "" defaultValue: "" permissions: - permissionType: View role: Viewer roleId: 10 - permissionType: None role: Participant roleId: 11 - permissionType: Modify role: Administrator roleId: 12 x-amf-mediaType: application/json post: tags: - Fields summary: Create a field description: "Creates a field within a table, including the custom permissions\ \ of that field." operationId: createField parameters: - name: tableId in: query description: The unique identifier of the table. required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - id type: object properties: id: type: integer description: "The id of the field, unique to this table." format: int64 fieldType: type: string description: "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)." mode: type: string description: "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: type: string description: The label (name) of the field. noWrap: type: boolean description: Indicates if the field is configured to not wrap when displayed in the product. bold: type: boolean description: Indicates if the field is configured to display in bold in the product. required: type: boolean description: Indicates if the field is marked required. appearsByDefault: type: boolean description: Indicates if the field is marked as a default in reports. findEnabled: type: boolean description: Indicates if the field is marked as searchable. unique: type: boolean description: Indicates if the field is marked unique. doesDataCopy: type: boolean description: Indicates if the field data will copy when a user copies the record. fieldHelp: type: string description: The configured help text shown to users within the product. audited: type: boolean description: Indicates if the field is being tracked as part of Quickbase Audit Logs. properties: type: object additionalProperties: true description: "Additional properties for the field. Please see\ \ [Field type details](../fieldInfo) page for more details on\ \ the properties for each field type." permissions: type: array description: Field Permissions for different roles. items: type: object additionalProperties: false additionalProperties: true example: id: 123 label: Field1 fieldType: text mode: "" noWrap: false bold: false required: false appearsByDefault: false findEnabled: false unique: false doesDataCopy: false fieldHelp: field help audited: false properties: primaryKey: false foreignKey: false numLines: 1 maxLength: 0 appendOnly: false allowHTML: false allowMentions: false sortAsGiven: false carryChoices: true allowNewChoices: false formula: "" defaultValue: "" permissions: - permissionType: View role: Viewer roleId: 10 - permissionType: None role: Participant roleId: 11 - permissionType: Modify role: Administrator roleId: 12 x-amf-mediaType: application/json x-codegen-request-body-name: generated delete: tags: - Fields summary: Delete field(s) description: "Deletes one or many fields in a table, based on field id. This\ \ will also permanently delete any data or calculations in that field." operationId: deleteFields parameters: - name: tableId in: query description: The unique identifier of the table. required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - deletedFieldIds - errors type: object properties: deletedFieldIds: type: array description: List of field IDs to were deleted. items: type: integer errors: type: array description: List of errors found. items: type: string additionalProperties: true example: deletedFieldIds: - 6 - 8 errors: - "Error found with fid: 7" x-amf-mediaType: application/json x-codegen-request-body-name: generated /fields/{fieldId}: get: tags: - Fields summary: Get field description: "Gets the properties of an individual field, based on field id.\ \ \nProperties 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](../fieldInfo) for more details\ \ on the properties for each field type." operationId: getField parameters: - name: tableId in: query description: The unique identifier (dbid) of the table. required: true schema: type: string - name: includeFieldPerms in: query description: Set to 'true' if you'd like to get back the custom permissions for the field(s). schema: type: boolean default: false - name: fieldId in: path description: The unique identifier (fid) of the field. required: true schema: type: integer - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - id type: object properties: id: type: integer description: "The id of the field, unique to this table." format: int64 fieldType: type: string description: "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)." mode: type: string description: "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: type: string description: The label (name) of the field. noWrap: type: boolean description: Indicates if the field is configured to not wrap when displayed in the product. bold: type: boolean description: Indicates if the field is configured to display in bold in the product. required: type: boolean description: Indicates if the field is marked required. appearsByDefault: type: boolean description: Indicates if the field is marked as a default in reports. findEnabled: type: boolean description: Indicates if the field is marked as searchable. unique: type: boolean description: Indicates if the field is marked unique. doesDataCopy: type: boolean description: Indicates if the field data will copy when a user copies the record. fieldHelp: type: string description: The configured help text shown to users within the product. audited: type: boolean description: Indicates if the field is being tracked as part of Quickbase Audit Logs. properties: type: object additionalProperties: true description: "Additional properties for the field. Please see\ \ [Field type details](../fieldInfo) page for more details on\ \ the properties for each field type." permissions: type: array description: Field Permissions for different roles. items: type: object additionalProperties: false additionalProperties: true example: id: 123 label: Field1 fieldType: text mode: "" noWrap: false bold: false required: false appearsByDefault: false findEnabled: false unique: false doesDataCopy: false fieldHelp: field help audited: false properties: primaryKey: false foreignKey: false numLines: 1 maxLength: 0 appendOnly: false allowHTML: false allowMentions: false sortAsGiven: false carryChoices: true allowNewChoices: false formula: "" defaultValue: "" permissions: - permissionType: View role: Viewer roleId: 10 - permissionType: None role: Participant roleId: 11 - permissionType: Modify role: Administrator roleId: 12 x-amf-mediaType: application/json post: tags: - Fields summary: Update a field description: "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." operationId: updateField parameters: - name: tableId in: query description: The unique identifier of the table. required: true schema: type: string - name: fieldId in: path description: The unique identifier (fid) of the field. required: true schema: type: integer - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - id type: object properties: id: type: integer description: "The id of the field, unique to this table." format: int64 fieldType: type: string description: "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)." mode: type: string description: "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: type: string description: The label (name) of the field. noWrap: type: boolean description: Indicates if the field is configured to not wrap when displayed in the product. bold: type: boolean description: Indicates if the field is configured to display in bold in the product. required: type: boolean description: Indicates if the field is marked required. appearsByDefault: type: boolean description: Indicates if the field is marked as a default in reports. findEnabled: type: boolean description: Indicates if the field is marked as searchable. unique: type: boolean description: Indicates if the field is marked unique. doesDataCopy: type: boolean description: Indicates if the field data will copy when a user copies the record. fieldHelp: type: string description: The configured help text shown to users within the product. audited: type: boolean description: Indicates if the field is being tracked as part of Quickbase Audit Logs. properties: type: object additionalProperties: true description: "Additional properties for the field. Please see\ \ [Field type details](../fieldInfo) page for more details on\ \ the properties for each field type." permissions: type: array description: Field Permissions for different roles. items: type: object additionalProperties: false additionalProperties: true example: id: 123 label: Field1 fieldType: text mode: "" noWrap: false bold: false required: false appearsByDefault: false findEnabled: false unique: false doesDataCopy: false fieldHelp: field help audited: false properties: primaryKey: false foreignKey: false numLines: 1 maxLength: 0 appendOnly: false allowHTML: false allowMentions: false sortAsGiven: false carryChoices: true allowNewChoices: false formula: "" defaultValue: "" permissions: - permissionType: View role: Viewer roleId: 10 - permissionType: None role: Participant roleId: 11 - permissionType: Modify role: Administrator roleId: 12 x-amf-mediaType: application/json x-codegen-request-body-name: generated /fields/usage: get: tags: - Fields summary: Get usage for all fields description: 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. operationId: getFieldsUsage parameters: - name: tableId in: query description: The unique identifier (dbid) of the table. required: true schema: type: string - name: skip in: query description: The number of fields to skip from the list. schema: type: integer - name: top in: query description: The maximum number of fields to return. schema: type: integer - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: array example: - field: id: 6 name: name type: Text usage: actions: count: 0 appHomePages: count: 0 dashboards: count: 2 defaultReports: count: 1 exactForms: count: 0 fields: count: 0 forms: count: 1 notifications: count: 0 personalReports: count: 0 pipelines: count: 1 relationships: count: 0 reminders: count: 0 reports: count: 2 roles: count: 2 tableImports: count: 3 tableRules: count: 1 webhooks: count: 0 items: type: object additionalProperties: true x-amf-mediaType: application/json /fields/usage/{fieldId}: get: tags: - Fields summary: Get usage for a field description: Get a single fields usage statistics. This is a summary of the information that can be found in the usage table of field properties. operationId: getFieldUsage parameters: - name: tableId in: query description: The unique identifier (dbid) of the table. required: true schema: type: string - name: fieldId in: path description: The unique identifier (fid) of the field. required: true schema: type: integer - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: array example: - field: id: 6 name: name type: Text usage: actions: count: 0 appHomePages: count: 0 dashboards: count: 2 defaultReports: count: 1 exactForms: count: 0 fields: count: 0 forms: count: 1 notifications: count: 0 personalReports: count: 0 pipelines: count: 1 relationships: count: 0 reminders: count: 0 reports: count: 2 roles: count: 2 tableImports: count: 2 tableRules: count: 1 webhooks: count: 0 items: type: object additionalProperties: true x-amf-mediaType: application/json /formula/run: post: tags: - Formulas summary: Run a formula description: 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. operationId: runFormula parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: result: type: string description: The formula execution result. additionalProperties: true example: result: "30" x-amf-mediaType: application/json x-codegen-request-body-name: generated /records: post: tags: - Records summary: Insert/Update record(s) description: "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](../fieldInfo) 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. \n**Note:** This endpoint\ \ supports a maximum payload size of 40MB." operationId: upsert parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: "" content: application/json: schema: type: object properties: metadata: type: object additionalProperties: true description: "Information about created records, updated records,\ \ referenced but unchanged records, and records having any errors\ \ while being processed." data: type: array description: The data that is expected to be returned. items: type: object additionalProperties: true description: "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." example: value: data: - "3": value: 1 "6": value: Updating this record "7": value: 10 "8": value: 2019-12-18T08:00:00.000Z - "3": value: 11 "6": value: This is my text "7": value: 15 "8": value: 2019-12-19T08:00:00.000Z - "3": value: 12 "6": value: This is my other text "7": value: 20 "8": value: 2019-12-20T08:00:00.000Z metadata: createdRecordIds: - 11 - 12 totalNumberOfRecordsProcessed: 3 unchangedRecordIds: [] updatedRecordIds: - 1 x-amf-mediaType: application/json "207": description: "" content: application/json: schema: type: object properties: metadata: type: object additionalProperties: true description: "Information about created records, updated records,\ \ referenced but unchanged records, and records having any errors\ \ while being processed." data: type: array description: The data that is expected to be returned. items: type: object additionalProperties: true description: "Receiving this status code indicates that some (or all)\ \ of the individual records being handled had problems and were\ \ not processed successfully. The response will be reported under\ \ the 'lineErrors' element and indicate the total number of records\ \ processed and the errors that occurred with each record. The record\ \ IDs of records created, updated, and referenced but unchanged,\ \ will be returned in the 'createdRecordIds', 'updatedRecordIds',\ \ and 'unchangedRecordIds' elements respectively. \nIn the example\ \ below, a user tries to add three records to a table that previously\ \ had ten records with IDs from 1 through 10. The first and third\ \ records of the request are valid and create the 11th and 12th\ \ records in the table; the second record has a problem that prevents\ \ it from being processed." example: value: data: [] metadata: createdRecordIds: - 11 - 12 lineErrors: "2": - Incompatible value for field with ID "6". totalNumberOfRecordsProcessed: 3 unchangedRecordIds: [] updatedRecordIds: [] x-amf-mediaType: application/json "400": description: "" content: application/json: schema: type: object properties: message: type: string description: The type of error found. description: type: string description: The description for the occurence of the error. additionalProperties: true description: "There was problem in the format of the request. This\ \ prevented the entire request from processing any records. The\ \ error response will be in the [standard format](../errors)." example: message: Bad request description: Data object cannot be empty. x-amf-mediaType: application/json x-codegen-request-body-name: generated delete: tags: - Records summary: Delete record(s) description: "Deletes record(s) in a table based on a query. Alternatively,\ \ all records in the table can be deleted." operationId: deleteRecords parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Successful delete records response. content: application/json: schema: type: object properties: numberDeleted: type: integer description: The number of records deleted. example: 1 additionalProperties: true example: numberDeleted: 1 x-amf-mediaType: application/json x-codegen-request-body-name: generated /records/query: post: tags: - Records summary: Query for data description: "Pass in a query in the [Quickbase query language](https://help.quickbase.com/api-guide/componentsquery.html).\ \ Returns record data with [intelligent pagination](../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." operationId: runQuery parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: fields: type: array description: 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. items: type: object additionalProperties: true data: type: array description: "An array of objects that either represents the record\ \ data or summarized values, depending on the report type." items: type: object metadata: type: object additionalProperties: true description: "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." additionalProperties: true example: value: data: - "6": value: Andre Harris "7": value: 10 "8": value: 2019-12-18T08:00:00Z fields: - id: 6 label: Full Name type: text - id: 7 label: Amount type: numeric - id: 8 label: Date time type: date time metadata: totalRecords: 10 numRecords: 1 numFields: 3 skip: 0 x-amf-mediaType: application/json x-codegen-request-body-name: generated /records/modifiedSince: post: tags: - Records summary: Get records modified since description: |- Checks for record changes on the current table and crawls the record dependency graph based on a provided field list. This determines if records on the table changed after the provided timestamp, when factoring in their dependencies. This API requires app admin permissions and only reviews lookup and summary fields in supported relationships. To return deleted records for the current table, 'Index record changes' must be enabled. Dependent tables only evaluate current records, and deleted records are not supported. operationId: recordsModifiedSince parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - count type: object properties: count: type: integer description: The count of changes found. changes: type: array description: "When includeDetails is true, this array contains\ \ the individual record changes. If includeDetails is false,\ \ this array will not be returned." items: type: object additionalProperties: true deletesTruncated: type: boolean description: "When true, this indicates that the number of deletes\ \ detected exceeded the limit and details could not be returned." additionalProperties: true example: count: 2 changes: - recordId: 1 timestamp: 2025-09-04T20:10:22Z changeType: MODIFY - recordId: 2 timestamp: 2025-09-04T20:11:22Z changeType: DELETE x-amf-mediaType: application/json x-codegen-request-body-name: generated /auth/temporary/{dbid}: get: tags: - Auth summary: Get a temporary token for a dbid description: "Use this endpoint to get a temporary authorization token, scoped\ \ to either an app or a table. It can only be used inside of code pages for\ \ client-side authentication because it relies on the browser session. Learn\ \ more about [extending Quickbase](https://helpv2.quickbase.com/hc/en-us/articles/4570341709844-Extending-Quickbase).\ \ You can then use this token to make other API calls (see [authorization](../auth)).\ \ This token expires in 5 minutes." operationId: getTempTokenDBID parameters: - name: dbid in: path description: The unique identifier of an app or table. required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string - name: QB-App-Token in: header description: Your Quickbase app token schema: type: string responses: "200": description: "This token is used in the authorization header value (similar\ \ to the QB-USER-TOKEN), except it uses the QB-TEMP-TOKEN prefix header['Authorization']\ \ = 'QB-TEMP-TOKEN {token}'" content: application/json: schema: type: object properties: temporaryAuthorization: type: string description: Temporary authorization token. additionalProperties: true example: temporaryAuthorization: token x-amf-mediaType: application/json /auth/oauth/token: post: tags: - Auth summary: Exchange an SSO token description: "Use this endpoint to exchange a SAML assertion for a Quickbase\ \ token following [RFC 8693](https://www.rfc-editor.org/rfc/rfc8693.html).\ \ Callers can choose to return a token compatible with SCIM, XML, or RESTful\ \ APIs. The token duration is determined by the [SAML timeout session time](https://helpv2.quickbase.com/hc/en-us/articles/4570410646420-SAML-assertion-example#:~:text=Setting%20SAML%20timeout%20session%20time).\ \ You must be able to create a SAML assertion in your code to use this endpoint.\ \ The SAML assertion is verified against the configuration on the realm. Learn\ \ more about about [SAML assertions](https://helpv2.quickbase.com/hc/en-us/articles/4570410646420-SAML-assertion-example)." operationId: exchangeSsoToken parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: type: object properties: access_token: type: string description: 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: type: string description: An identifier for the representation of the issued security token. enum: - urn:quickbase:params:oauth:token-type:temp_ticket - urn:quickbase:params:oauth:token-type:temp_token token_type: type: string description: Will always return `N_A` enum: - N_A additionalProperties: true example: access_token: example_token_1NiIsImtpZCI6IjllciJ9w issued_token_type: urn:quickbase:params:oauth:token-type:temp_ticket token_type: N_A x-amf-mediaType: application/json x-codegen-request-body-name: generated /usertoken/clone: post: tags: - UserToken summary: Clone a user token description: Clones the authenticated user token. All applications associated with that token are automatically associated with the new token. operationId: cloneUserToken parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: "" content: application/json: schema: type: object properties: active: type: boolean description: Whether the user token is active. apps: type: array description: The list of apps this user token is assigned to. items: type: object additionalProperties: true lastUsed: type: string description: "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: type: string description: User Token description. id: type: integer description: User Token id. name: type: string description: User Token name. token: type: string description: User Token value. additionalProperties: true example: active: true apps: - id: bpqe82s1 name: My first app - id: bpqe82s2 name: My second app lastUsed: 2020-03-27T18:34:12.000Z description: Cloned user token id: 5 name: My cloned user token token: token x-amf-mediaType: application/json x-codegen-request-body-name: generated /usertoken/transfer: post: tags: - UserToken summary: Transfer a user token description: "Transfers the specified user token. Application associations will\ \ remain intact. For security, permissions must manually be reconciled." operationId: transferUserToken parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: "" content: application/json: schema: type: object properties: active: type: boolean description: Whether the user token is active. apps: type: array description: The list of apps this user token is assigned to. items: type: object additionalProperties: true lastUsed: type: string description: "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: type: string description: User Token description. id: type: integer description: User Token id. name: type: string description: User Token name. additionalProperties: true example: active: true apps: - id: bpqe82s1 name: My first app - id: bpqe82s2 name: My second app lastUsed: 2020-03-27T18:34:12.000Z description: Transferred user token id: 5 name: My transferred user token x-amf-mediaType: application/json x-codegen-request-body-name: generated /usertoken/deactivate: post: tags: - UserToken summary: Deactivate a user token description: "Deactivates the authenticated user token. Once this is done, the\ \ user token must be reactivated in the user interface." operationId: deactivateUserToken parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: "" content: application/json: schema: type: object properties: id: type: integer description: The user token id. additionalProperties: true example: id: 5 x-amf-mediaType: application/json /usertoken: delete: tags: - UserToken summary: Delete a user token description: Deletes the authenticated user token. This is not reversible. operationId: deleteUserToken parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: "" content: application/json: schema: type: object properties: id: type: integer description: The user token id. additionalProperties: true example: id: 5 x-amf-mediaType: application/json /files/{tableId}/{recordId}/{fieldId}/{versionNumber}: get: tags: - Files summary: Download file description: "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." operationId: downloadFile parameters: - name: tableId in: path description: The unique identifier of the table. required: true schema: type: string - name: recordId in: path description: The unique identifier of the record. required: true schema: type: integer - name: fieldId in: path description: The unique identifier of the field. required: true schema: type: integer - name: versionNumber in: path description: The file attachment version number. required: true schema: type: integer - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object description: Base64 encoded file content. example: UXVpY2sgQmFzZSBJbmMu x-amf-mediaType: application/octet-stream delete: tags: - Files summary: Delete file description: "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." operationId: deleteFile parameters: - name: tableId in: path description: The unique identifier of the table. required: true schema: type: string - name: recordId in: path description: The unique identifier of the record. required: true schema: type: integer - name: fieldId in: path description: The unique identifier of the field. required: true schema: type: integer - name: versionNumber in: path description: The file attachment version number. required: true schema: type: integer - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Successfully Deleted the File Attachment content: application/json: schema: type: object properties: versionNumber: type: integer description: The number of deleted version. fileName: type: string description: The name of file associated with deleted version. uploaded: type: string description: The timestamp when the version was originally uploaded. creator: type: object additionalProperties: true description: The user that uploaded version. additionalProperties: true example: versionNumber: 1 fileName: file.pdf uploaded: 2019-12-18T08:00:00Z creator: email: jsmith@quickbase.com id: 123456.ab1s name: Juliet Smith userName: jsmith x-amf-mediaType: application/json /users: post: tags: - Users summary: Get users description: "Get all users in an account or narrowed down list of users filtered\ \ by email(s). The returned users may be paginated depending on the user count.\ \ The count of the returned users may vary. When `nextPageToken` value in\ \ the response is not empty, that indicates that there are more results to\ \ be returned, you can use this value to get the next result set ('page')." operationId: getUsers parameters: - name: accountId in: query description: "The account id being used to get users. If no value is specified,\ \ the first account associated with the requesting user token is chosen." schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - metadata - users type: object properties: users: type: array description: A list of users found in an account with the given criterias items: type: object additionalProperties: true metadata: type: object additionalProperties: true description: Additional request information additionalProperties: true x-amf-examples: All results example: users: - userName: jdoe firstName: Jon lastName: Doe emailAddress: jdoe@domain.com hashId: 58351651.xc1 - userName: swilson firstName: Simone lastName: Wilson emailAddress: jswilson@domain.com hashId: 58351648.xc1 - userName: sjackson firstName: Samuel lastName: Jackson emailAddress: sjackson@domain.com hashId: 58351643.xc1 metadata: nextPageToken: "" Paged results example: users: - userName: swilson firstName: Simone lastName: Wilson emailAddress: jswilson@domain.com hashId: 58351648.xc1 - userName: sjackson firstName: Samuel lastName: Jackson emailAddress: sjackson@domain.com hashId: 58351643.xc1 metadata: nextPageToken: bzw2ba x-amf-mediaType: application/json x-codegen-request-body-name: generated /users/deny: put: tags: - Users summary: Deny users description: Denies users access to the realm but leaves them listed in groups they have been added to. operationId: denyUsers parameters: - name: accountId in: query description: "The account id being used to deny users. If no value is specified,\ \ the first account associated with the requesting user token is chosen." schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of users that couldn't be denied. This also includes the ID's of users that are not valid. example: - 78910.qwer - 3512.asd1 items: type: string success: type: array description: A list of users that have successfully been denied. example: - 123456.ab1s items: type: string additionalProperties: true example: failure: - 423123.vc2d - 78910.ba1s success: - 123456.ab1s x-amf-mediaType: application/json x-codegen-request-body-name: generated /users/deny/{shouldDeleteFromGroups}: put: tags: - Users summary: Deny and remove users from groups description: Denies users access to the realm and allows you to remove them from groups. operationId: denyUsersAndGroups parameters: - name: accountId in: query description: "The account id being used to deny users. If no value is specified,\ \ the first account associated with the requesting user token is chosen." schema: type: number - name: shouldDeleteFromGroups in: path description: Specifies if the users should also be removed from all groups. required: true schema: type: boolean - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of users that couldn't be denied. This also includes the ID's of users that are not valid. example: - 78910.qwer - 3512.asd1 items: type: string success: type: array description: A list of users that have successfully been denied. example: - 123456.ab1s items: type: string additionalProperties: true example: failure: - 423123.vc2d - 78910.ba1s success: - 123456.ab1s x-amf-mediaType: application/json x-codegen-request-body-name: generated /users/undeny: put: tags: - Users summary: Undeny users description: Grants users that have previously been denied access to the realm. operationId: undenyUsers parameters: - name: accountId in: query description: "The account id being used to undeny users. If no value is specified,\ \ the first account associated with the requesting user token is chosen." schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of users that couldn't be undenied. This also includes the ID's of users that are not valid. example: - 78910.qwer - 3512.asd1 items: type: string success: type: array description: A list of users that have successfully been undenied. example: - 123456.ab1s items: type: string additionalProperties: true example: failure: - 423123.vc2d - 78910.ba1s success: - 123456.ab1s x-amf-mediaType: application/json x-codegen-request-body-name: generated /groups/{gid}/members: post: tags: - Groups summary: Add members description: Adds a list of users to a given group as members. operationId: addMembersToGroup parameters: - name: gid in: path description: This is the ID of the group being modified. required: true schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: 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. example: - 423123.b3x5 - 123456.ryyw items: type: string success: type: array description: A list of users that have been added to the group successfully. example: - 100000.be8s items: type: string additionalProperties: true example: failure: - 123456.ryyw - 423123.b3x5 success: - 100000.be8s x-amf-mediaType: application/json x-codegen-request-body-name: generated delete: tags: - Groups summary: Remove members description: Removes a list of members from a given group. operationId: removeMembersFromGroup parameters: - name: gid in: path description: This is the ID of the group being modified. required: true schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of users that couldn't be removed from the group. This includes a list of IDs that represent invalid users. example: - 423123.b3x5 - 123456.ryyw items: type: string success: type: array description: A list of users that have been removed from the group successfully. example: - 100000.be8s items: type: string additionalProperties: true example: failure: - 123456.ryyw - 423123.b3x5 success: - 100000.be8s x-amf-mediaType: application/json x-codegen-request-body-name: generated /groups/{gid}/managers: post: tags: - Groups summary: Add managers description: Adds a list of users to a given group as managers. operationId: addManagersToGroup parameters: - name: gid in: path description: This is the ID of the group being modified. required: true schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: 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. example: - 423123.b3x5 - 123456.ryyw items: type: string success: type: array description: A list of users that have been added to the group successfully. example: - 100000.be8s items: type: string additionalProperties: true example: failure: - 123456.ryyw - 423123.b3x5 success: - 100000.be8s x-amf-mediaType: application/json x-codegen-request-body-name: generated delete: tags: - Groups summary: Remove managers description: Removes a list of managers from a given group. operationId: removeManagersFromGroup parameters: - name: gid in: path description: This is the ID of the group being modified. required: true schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of users that couldn't be removed from the group. This includes a list of IDs that represent invalid users. example: - 423123.b3x5 - 123456.ryyw items: type: string success: type: array description: A list of users that have been removed from the group successfully. example: - 100000.be8s items: type: string additionalProperties: true example: failure: - 123456.ryyw - 423123.b3x5 success: - 100000.be8s x-amf-mediaType: application/json x-codegen-request-body-name: generated /groups/{gid}/subgroups: post: tags: - Groups summary: Add child groups description: Adds a list of groups to a given group. operationId: addSubgroupsToGroup parameters: - name: gid in: path description: This is the ID of the group being modified. required: true schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: 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. example: - 1002.czm8 items: type: string success: type: array description: A list of child groups that have been added to the group successfully. example: - 1003.bar3 items: type: string additionalProperties: true example: failure: - 1002.czm8 success: - 1003.bar3 x-amf-mediaType: application/json x-codegen-request-body-name: generated delete: tags: - Groups summary: Remove child groups description: Removes a list of groups from a given group. operationId: removeSubgroupsFromGroup parameters: - name: gid in: path description: This is the ID of the group being modified. required: true schema: type: number - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of child groups that couldn't be removed from the group. This includes a list of IDs that represent invalid groups. example: - 1002.czm8 items: type: string success: type: array description: A list of child groups that have been removed from the group successfully. example: - 1003.bar3 items: type: string additionalProperties: true example: failure: - 1002.czm8 success: - 1003.bar3 x-amf-mediaType: application/json x-codegen-request-body-name: generated /audit: post: tags: - Audit summary: Get audit logs description: "Gathers the audit logs for a single day from a realm. By default,\ \ this API returns 10,000 entries. This can be changed with the numRows parameter.\ \ Integrators can iterate through batches to get an entire day's worth of\ \ logs. Each realm has a maximum entitlement of querying 1,000 days per year\ \ (allowing lookbacks for up to two years). Requests for paginated data do\ \ not count towards the annual limit. Transactional rate limits are 10 per\ \ 10 seconds. \n**Note:** This API is available for enterprise users only." operationId: audit parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Query ran successfully and has returned the events for the given time period. content: application/json: schema: required: - queryId type: object properties: queryId: type: string description: Query id of the requested audit log. events: type: array description: All events of the audit log. items: type: object additionalProperties: true nextToken: type: string description: Token to fetch the next 1000 logs. additionalProperties: true example: events: - firstname: Jon lastname: Doe email: jdoe@quickbase.com ipaddress: 65.219.241.162 application: UI resourceurl: https://demo.quickbase.com/db/bpqe82s1 sessioninfo: "Session ID: 17245317" useragent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/605.1.15\ \ (KHTML, like Gecko) Version/13.1 Safari/605.1.15" topic: app_dashboard_access description: Jon Doe accessed the app dashboard in app Projects id: I3g8gm2cmh-1 time: 2020-04-21T14:41:51.886Z nextToken: 6a.f12x queryId: 797c0726-f8f4-4df9-883f-c7e8cbdf2f77.ALtInpuyQeBoW+fWrAqLrjPGqDqPl++IMb3bOxlmoF4= x-amf-mediaType: application/json "202": description: Query still being processed. Pass the queryId back to the API to check for results. content: application/json: schema: required: - queryId type: object properties: queryId: type: string description: Query id of the requested audit log. additionalProperties: true example: queryId: 797c0726-f8f4-4df9-883f-c7e8cbdf2f77.ALtInpuyQeBoW+fWrAqLrjPGqDqPl++IMb3bOxlmoF4= x-amf-mediaType: application/json x-codegen-request-body-name: generated /analytics/reads: get: tags: - Platform Analytics summary: Get read summaries description: "Get user read and integration read summaries for any day in the\ \ past. \n**Note:** This API is available for enterprise users only." operationId: platformAnalyticReads parameters: - name: day in: query description: "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." schema: type: string format: date - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string responses: "200": description: Summaries returned succesfully content: application/json: schema: required: - data type: object properties: data: type: object additionalProperties: true description: The data object containing the read summaries. additionalProperties: true example: data: dailyDetailedReads: date: 2022-01-01 reads: integrations: api: 456 eoti: 789 pipelines: 432 user: 123 x-amf-mediaType: application/json /analytics/events/summaries: post: tags: - Platform Analytics summary: Get event summaries description: |- Get event summaries for any span of days up to one year and excluding future dates. **Note:** This API is available for enterprise users only. Data is updated hourly; to ensure accuracy, query dates should be at least one hour in the past. Transactional rate limits are 100 per hour. operationId: platformAnalyticEventSummaries parameters: - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com." required: true schema: type: string - name: User-Agent in: header description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities. schema: type: string - name: accountId in: query description: "The ID of the account to query. If no value is specified, the\ \ first account matching the provided domain is chosen." schema: type: number responses: "200": description: Event summaries returned succesfully content: application/json: schema: required: - data type: object properties: data: required: - eventsSummaries type: object properties: eventsSummaries: required: - accountId - end - groupBy - metadata - results - start - totals - where type: object properties: accountId: type: string description: The ID of the account the events are associated with. start: type: string description: The start date and time of the requested summaries in ISO 8601 time format. format: date-time end: type: string description: The end date and time of the requested summaries in ISO 8601 time format. format: date-time groupBy: type: string description: How the events should be grouped. enum: - app - user where: type: array items: required: - id - type type: object properties: id: type: string description: Id of the item to filter by. type: type: string description: The type of item to filter by. enum: - app - user results: type: array description: An array of objects that contains Application/User information and an events object with summaries by event type. items: required: - eventTypes - id - name - totals type: object properties: id: type: string description: Id of the Application/User. name: type: string description: Name of the Application/User. totals: type: object properties: integration: type: number user: type: number all: type: number description: Totals by billing category for the event grouping. eventTypes: type: array description: An array of events that contains specific information associated with an Application/User broken down by event type. items: type: object properties: eventType: type: string description: Event type count: type: integer description: Count of events associated with that event type and Application/User. billingCategory: type: string description: Billing category of the event type. enum: - user - integration metadata: required: - nextToken type: object properties: nextToken: type: string description: Supply this token in a subsequent request to fetch the next page of results. description: Additional information about the results that may be helpful. totals: type: object properties: integration: type: number user: type: number all: type: number description: Totals by billing category for all queried events. example: data: eventsSummaries: accountId: "1234" start: 2023-12-01T05:00:00Z end: 2023-12-31T05:00:00Z groupBy: user where: - id: 58351651.xc1 type: user - id: bpqe82s1 type: app results: - id: 58351651.xc1 name: Jon Doe totals: integration: 997 user: 455 all: 1452 eventTypes: - eventType: api count: 794 billingCategory: integration - eventType: eoti count: 0 billingCategory: integration - eventType: stepruns count: 203 billingCategory: integration - eventType: plugin count: 0 billingCategory: user - eventType: appDashboard count: 36 billingCategory: user - eventType: tableDashboard count: 0 billingCategory: user - eventType: form count: 419 billingCategory: user - eventType: report count: 0 billingCategory: user totals: integration: 997 user: 455 all: 1452 metadata: nextToken: 6a.f12x x-amf-mediaType: application/json x-codegen-request-body-name: generated /solutions/{solutionId}: get: tags: - Solutions summary: Export a solution description: "Returns the QBL for the specified solution. Learn more about [QBL\ \ syntax](https://help.quickbase.com/docs/qbl-definition-structure-and-syntax).\ \ \n We are releasing schema coverage for QBL in stages. See [what's supported\ \ today](https://help.quickbase.com/docs/qbl-versions) in our QBL documentation." operationId: exportSolution parameters: - name: solutionId in: path description: The unique identifier (UUID) or the alias of the solution. required: true schema: type: string - name: QBL-Version in: header description: The QBL version to be used for the export. If not specified the default would be used. schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/x-yaml: schema: type: object example: "Solution:\n Id: 8d2c3333-7d32-4ece-8073-57106c465384\n\ \ Name: Example solution\n Owner: manager@yourrealm.com\n ExportDate:\ \ 2024-03-25 12:04:05\nVersion: 0.2\nResources:\n $App_Example_app:\n\ \ Type: QB::Application\n Properties:\n Name: Example\ \ app\n Description: \n AppColor: '#72509a'\n Manager:\ \ manager@yourrealm.com\n TableOrder: []\n AppIcon: Application\n\ \ CurrencySymbol: $\n FiscalYearDesignation: Last\n \ \ FirstDayOfWeek: Sun\n DateFormat: MM-DD-YYYY\n FirstMonthOfFiscalYear:\ \ Jan\n CurrencySymbolPosition: Between\n NumberFormat:\n\ \ SeparatorStyle: CommaGroupingPeriodDecimal\n SeparatorPlaces:\ \ none\n DefaultViewMode: Auto\n HideNewUpdatedIcons:\ \ false\n DisableAllUsersSelection: false\n CanCopyApp:\ \ Admin\n CanExportData: Everyone\n Searchable: false\n\ \ RequireAppToken: true\n ShowPerformanceBar: false\n\ \ ShowPerformanceAnalyzer: false\n GlobalSearchExactMatch:\ \ false\n Utf8DataEncoding: false\n Timezone: Default\n\ \ Branding:\n AppHeader:\n HideQuickbaseStandardMenu:\ \ false\n AppFooter: {}\n RoleOrder:\n - !Ref\n\ \ Role: $Role_Viewer\n - !Ref\n Role: $Role_Participant\n\ \ - !Ref\n Role: $Role_Administrator\n Roles:\n\ \ $Role_Viewer:\n Type: QB::Application::Role\n \ \ Properties:\n Name: Viewer\n Description:\ \ \n Default: false\n ManageUsers: false\n \ \ EditApp: false\n DisableAccess: false\n \ \ AppUI:\n HideSettings: false\n HideUsers:\ \ false\n HideFavorites: false\n HideSearch:\ \ false\n HideHelp: false\n HideTestAs: false\n\ \ TableUI:\n Global:\n HideInBar:\ \ false\n HideNewRecord: false\n HideGridEdit:\ \ false\n HideEmail: false\n HidePrint:\ \ false\n HideImportExport: false\n HideSaveSpreadsheet:\ \ false\n HideCreateCustomizeReport: false\n \ \ HidePersonalSettings: false\n $Role_Participant:\n\ \ Type: QB::Application::Role\n Properties:\n \ \ Name: Participant\n Description: \n Default:\ \ true\n ManageUsers: true\n EditApp: false\n\ \ DisableAccess: false\n AppUI:\n HideSettings:\ \ false\n HideUsers: false\n HideFavorites:\ \ false\n HideSearch: false\n HideHelp: false\n\ \ HideTestAs: false\n TableUI:\n \ \ Global:\n HideInBar: false\n HideNewRecord:\ \ false\n HideGridEdit: false\n HideEmail:\ \ false\n HidePrint: false\n HideImportExport:\ \ false\n HideSaveSpreadsheet: false\n \ \ HideCreateCustomizeReport: false\n HidePersonalSettings:\ \ false\n $Role_Administrator:\n Type: QB::Application::Role\n\ \ Properties:\n Name: Administrator\n Description:\ \ \n Default: false\n ManageUsers: true\n \ \ EditApp: true\n DisableAccess: false\n \ \ AppUI:\n HideSettings: false\n HideUsers:\ \ false\n HideFavorites: false\n HideSearch:\ \ false\n HideHelp: false\n HideTestAs: false\n\ \ TableUI:\n Global:\n HideInBar:\ \ false\n HideNewRecord: false\n HideGridEdit:\ \ false\n HideEmail: false\n HidePrint:\ \ false\n HideImportExport: false\n HideSaveSpreadsheet:\ \ false\n HideCreateCustomizeReport: false\n \ \ HidePersonalSettings: false" x-amf-mediaType: application/x-yaml "400": description: "Bad request. For example: Missing required headers, Missing\ \ required parameters, Malformed QBL and others. Message should provide\ \ more information, reach out to support if there's lack of clarity." content: application/x-yaml: schema: type: object example: message: Bad request. description: "" x-amf-mediaType: application/json "404": description: Solution does not exist. The supplied solution ID was not found. content: application/x-yaml: schema: type: object example: message: Not found. description: "" x-amf-mediaType: application/json "401": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/x-yaml: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "403": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/x-yaml: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "4XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/x-yaml: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json "5XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/x-yaml: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json put: tags: - Solutions summary: Update a solution description: "Updates the solution using the provided QBL. Learn more about\ \ [QBL syntax](https://help.quickbase.com/hc/en-us/articles/24845511223828-What-is-QBL).\ \ \n We are releasing schema coverage for QBL in stages. See [what's supported\ \ today](https://helpv2.quickbase.com/hc/en-us/sections/26699387198228-QBL-Versions)\ \ in our QBL documentation." operationId: updateSolution parameters: - name: solutionId in: path description: The unique identifier (UUID) or the alias of the solution. required: true schema: type: string - name: X-QBL-Errors-As-Success in: header description: "If this header is set to true, the API will return a 207 status\ \ code even if errors occur. The response will contain X-QBL-ORIGINAL-STATUS\ \ header with the original error code, and the response body will include\ \ the error details." schema: type: boolean - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object example: solutionId: 097aefef-113a-4fc1-9c78-3ecb1003b95c createdResources: apps: {} warnings: [] x-amf-mediaType: application/json "400": description: "Bad request. For example: Missing required headers, Missing\ \ required parameters, Malformed QBL and others. Message should provide\ \ more information, reach out to support if there's lack of clarity." content: application/json: schema: type: object example: message: Bad request description: "" x-amf-mediaType: application/json "401": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden description: "" x-amf-mediaType: application/json "403": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden description: "" x-amf-mediaType: application/json "4XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json "5XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json x-codegen-request-body-name: generated /solutions: post: tags: - Solutions summary: Create a solution description: "Creates a solution using the provided QBL. Learn more about [QBL\ \ syntax](https://help.quickbase.com/hc/en-us/articles/24845511223828-What-is-QBL).\ \ \n We are releasing schema coverage for QBL in stages. See [what's supported\ \ today](https://helpv2.quickbase.com/hc/en-us/sections/26699387198228-QBL-Versions)\ \ in our QBL documentation." operationId: createSolution parameters: - name: X-QBL-Errors-As-Success in: header description: "If this header is set to true, the API will return a 207 status\ \ code even if errors occur. The response will contain X-QBL-ORIGINAL-STATUS\ \ header with the original error code, and the response body will include\ \ the error details." schema: type: boolean - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object example: solutionId: 097aefef-113a-4fc1-9c78-3ecb1003b95c createdResources: apps: {} warnings: [] x-amf-mediaType: application/json "400": description: "Bad request. For example: Missing required headers, Missing\ \ required parameters, Malformed QBL and others. Message should provide\ \ more information, reach out to support if there's lack of clarity." content: application/json: schema: type: object example: message: Bad request. description: "" x-amf-mediaType: application/json "401": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "403": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "4XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json "5XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json x-codegen-request-body-name: generated /solutions/{solutionId}/torecord: get: tags: - Solutions summary: Export solution to record description: "Exports the solution and outputs the resulting QBL in a new record\ \ in the specified table. The QBL will be saved to a file in the file attachment\ \ field that is specified. The table cannot have any required fields besides\ \ the file attachment field. \n We are releasing schema coverage for QBL\ \ in stages. See [what's supported today](https://helpv2.quickbase.com/hc/en-us/sections/26699387198228-QBL-Versions)\ \ in our QBL documentation." operationId: exportSolutionToRecord parameters: - name: solutionId in: path description: The unique identifier of the solution. required: true schema: type: string - name: tableId in: query description: The unique identifier (dbid) of the table. required: true schema: type: string - name: fieldId in: query description: The unique identifier (fid) of the field. It needs to be a file attachment field. required: true schema: {} - name: X-QBL-Errors-As-Success in: header description: "If this header is set to true, the API will return a 207 status\ \ code even if errors occur. The response will contain X-QBL-ORIGINAL-STATUS\ \ header with the original error code, and the response body will include\ \ the error details." schema: type: boolean - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: QBL-Version in: header description: The QBL version to be used for the export. If not specified the default would be used. schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object example: record_id: 1 filename: QBL-0.4-30d92a39-5940-49b6-9eb1-c2966f85a7c0.yaml x-amf-mediaType: application/json "400": description: "Bad request. For example: Missing required headers, Missing\ \ required parameters, Malformed QBL and others. Message should provide\ \ more information, reach out to support if there's lack of clarity." content: application/json: schema: type: object example: message: Bad request. description: "" x-amf-mediaType: application/json "404": description: "A resource is missing. For example: The supplied solution\ \ or field does not exist." content: application/json: schema: type: object example: message: Not found. description: "" x-amf-mediaType: application/json "401": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "403": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "4XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json "5XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json /solutions/fromrecord: get: tags: - Solutions summary: Create solution from record description: "Creates a solution using the QBL from the specified record. \n\ \ We are releasing schema coverage for QBL in stages. See [what's supported\ \ today](https://helpv2.quickbase.com/hc/en-us/sections/26699387198228-QBL-Versions)\ \ in our QBL documentation." operationId: createSolutionFromRecord parameters: - name: tableId in: query description: The unique identifier (dbid) of the table. required: true schema: type: string - name: fieldId in: query description: The unique identifier (fid) of the field. It needs to be a file attachment field. required: true schema: {} - name: recordId in: query description: The unique identifier of the record. required: true schema: {} - name: X-QBL-Errors-As-Success in: header description: "If this header is set to true, the API will return a 207 status\ \ code even if errors occur. The response will contain X-QBL-ORIGINAL-STATUS\ \ header with the original error code, and the response body will include\ \ the error details." schema: type: boolean - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object example: solutionId: f53acd36-1e75-47ed-910c-0ca4fd165a84 createdResources: apps: $App_IT_Total_Management: bt6i6jc39 pipelines: {} warnings: [] x-amf-mediaType: application/json "400": description: "Bad request. For example: Missing required headers, Missing\ \ required parameters, Malformed QBL and others. Message should provide\ \ more information, reach out to support if there's lack of clarity." content: application/json: schema: type: object example: message: Bad request. description: "" x-amf-mediaType: application/json "404": description: "A resource is missing. For example: The supplied solution,\ \ field or record does not exist." content: application/json: schema: type: object example: message: Not found. description: "" x-amf-mediaType: application/json "401": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "403": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "4XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json "5XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json /solutions/{solutionId}/fromrecord: get: tags: - Solutions summary: Update solution from record description: "Updates a solution using the QBL from the specified record. \n\ \ We are releasing schema coverage for QBL in stages. See [what's supported\ \ today](https://helpv2.quickbase.com/hc/en-us/sections/26699387198228-QBL-Versions)\ \ in our QBL documentation." operationId: updateSolutionToRecord parameters: - name: solutionId in: path description: The unique identifier of the solution. required: true schema: type: string - name: tableId in: query description: The unique identifier (dbid) of the table. required: true schema: type: string - name: fieldId in: query description: The unique identifier (fid) of the field. It needs to be a file attachment field. required: true schema: {} - name: recordId in: query description: The unique identifier of the record. required: true schema: {} - name: X-QBL-Errors-As-Success in: header description: "If this header is set to true, the API will return a 207 status\ \ code even if errors occur. The response will contain X-QBL-ORIGINAL-STATUS\ \ header with the original error code, and the response body will include\ \ the error details." schema: type: boolean - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object example: solutionId: acfa89a2-5ec0-4552-ba69-1372e41288ea resources: apps: $App_IT_Total_Management: bt6i6jc39 pipelines: {} warnings: [] x-amf-mediaType: application/json "400": description: "Bad request. For example: Missing required headers, Missing\ \ required parameters, Malformed QBL and others. Message should provide\ \ more information, reach out to support if there's lack of clarity." content: application/json: schema: type: object example: message: Bad request. description: "" x-amf-mediaType: application/json "404": description: "A resource is missing. For example: The supplied solution,\ \ field or record does not exist." content: application/json: schema: type: object example: message: Not found. description: "" x-amf-mediaType: application/json "401": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "403": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "4XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json "5XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json /solutions/{solutionId}/changeset: put: tags: - Solutions summary: List solution changes description: "Returns a list of changes that would occur if the provided QBL\ \ were to be applied. Learn more about [QBL syntax](https://help.quickbase.com/hc/en-us/articles/24845511223828-What-is-QBL).\ \ \n We are releasing schema coverage for QBL in stages. See [what's supported\ \ today](https://helpv2.quickbase.com/hc/en-us/sections/26699387198228-QBL-Versions)\ \ in our QBL documentation." operationId: changesetSolution parameters: - name: solutionId in: path description: The unique identifier of the solution. required: true schema: type: string - name: X-QBL-Errors-As-Success in: header description: "If this header is set to true, the API will return a 207 status\ \ code even if errors occur. The response will contain X-QBL-ORIGINAL-STATUS\ \ header with the original error code, and the response body will include\ \ the error details." schema: type: boolean - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object example: id: f53acd36-1e75-47ed-910c-0ca4fd165a84 changes: - logicalType: App logicalId: $App_Example_app action: Add path: - $App_Example_app - logicalType: App logicalId: $App_Simple_Project_Manager action: Remove path: - $App_Simple_Project_Manager x-amf-mediaType: application/json "400": description: "Bad request. For example: Missing required headers, Missing\ \ required parameters, Malformed QBL and others. Message should provide\ \ more information, reach out to support if there's lack of clarity." content: application/json: schema: type: object example: message: Bad request. description: "" x-amf-mediaType: application/json "404": description: Solution does not exist. The supplied solution ID was not found. content: application/json: schema: type: object example: message: Not found. description: "" x-amf-mediaType: application/json "401": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "403": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "4XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json "5XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json x-codegen-request-body-name: generated /solutions/{solutionId}/changeset/fromrecord: get: tags: - Solutions summary: List solution changes from record description: "Returns a list of changes that would occur if the QBL from the\ \ provided record were to be applied. \n We are releasing schema coverage\ \ for QBL in stages. See [what's supported today](https://helpv2.quickbase.com/hc/en-us/sections/26699387198228-QBL-Versions)\ \ in our QBL documentation." operationId: changesetSolutionFromRecord parameters: - name: solutionId in: path description: The unique identifier of the solution. required: true schema: type: string - name: tableId in: query description: The unique identifier (dbid) of the table. required: true schema: type: string - name: fieldId in: query description: The unique identifier (fid) of the field. It needs to be a file attachment field. required: true schema: {} - name: recordId in: query description: The unique identifier of the record. required: true schema: {} - name: X-QBL-Errors-As-Success in: header description: "If this header is set to true, the API will return a 207 status\ \ code even if errors occur. The response will contain X-QBL-ORIGINAL-STATUS\ \ header with the original error code, and the response body will include\ \ the error details." schema: type: boolean - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object example: id: f53acd36-1e75-47ed-910c-0ca4fd165a84 changes: - logicalType: Property logicalId: App::$App_MVP_App_234::Property::Name action: Update path: - $App_MVP_App_234 - Name - logicalType: Table logicalId: $Table_Parents action: Remove path: - $App_MVP_App_234 - $Table_Parents - logicalType: Table logicalId: $Table_Children action: Remove path: - $App_MVP_App_234 - $Table_Children x-amf-mediaType: application/json "400": description: "Bad request. For example: Missing required headers, Missing\ \ required parameters, Malformed QBL and others. Message should provide\ \ more information, reach out to support if there's lack of clarity." content: application/json: schema: type: object example: message: Bad request. description: "" x-amf-mediaType: application/json "404": description: "A resource is missing. For example: The supplied solution,\ \ field or record does not exist." content: application/json: schema: type: object example: message: Not found. description: "" x-amf-mediaType: application/json "401": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "403": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot create apps and others. Message should\ \ provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json "4XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json "5XX": description: "Non-common error, reach out to support if there's lack of\ \ clarity." content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json /docTemplates/{templateId}/generate: get: tags: - Document Templates summary: Generate a document description: "Generates a document from a template. After changing a template,\ \ allow up to 15 minutes for documents generated via the API to reflect the\ \ changes. This feature is only available on business or enterprise plans." operationId: generateDocument parameters: - name: templateId in: path description: This is the ID of document template. required: true schema: type: number - name: tableId in: query description: The unique identifier of the table. required: true schema: type: string - name: recordId in: query description: The ID of the record schema: type: number - name: filename in: query description: File name for the downloaded file required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" schema: {} - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string - name: format in: query description: The format of the file that is returned. Default is "pdf". schema: {} - name: margin in: query description: "Margin formatted as top right bottom left, separated by spaces.\ \ Add to override the value set in the template builder." schema: {} - name: unit in: query description: Unit of measurement for the margin. Default is "in". Add to override the value set in the template builder. schema: {} - name: pageSize in: query description: Page size. Default is "A4". Add to override the value set in the template builder. schema: {} - name: orientation in: query description: Page orientation. Default is "portrait". Add to override the value set in the template builder. schema: {} - name: realm in: query description: "Your Quickbase domain, for example demo.quickbase.com" schema: {} responses: "200": description: Success content: "*/*": schema: type: object properties: fileName: type: string description: The file name. data: type: string description: Base64 encoded file content. contentType: type: string description: The document content type. additionalProperties: true example: fileName: Document.pdf data: data contentType: application/pdf x-amf-mediaType: application/json /solutions/{solutionId}/resources: get: tags: - Solutions summary: Get solution information description: "Returns the metadata and resource information for a solution,\ \ including both real and logical IDs of apps and pipelines contained within\ \ the solution. This endpoint provides programmatic access to solution structure\ \ information." operationId: getSolutionPublic parameters: - name: solutionId in: path description: The unique identifier (UUID) or the alias of the solution. required: true schema: type: string - name: X-QBL-Errors-As-Success in: header description: "If this header is set to true, the API will return a 207 status\ \ code even if errors occur. The response will contain X-QBL-Original-Status\ \ header with the original error code, and the response body will include\ \ the error details." schema: type: boolean - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: type: object example: uuid: f53acd36-1e75-47ed-910c-0ca4fd165a84 alias: my-solution-alias name: My Example Solution description: A solution containing example applications and pipelines createdAt: 2024-01-15T10:30:00Z updatedAt: 2024-03-22T14:45:00Z resources: apps: - id: bskapa2x3 logicalId: $App_Example_app - id: bskbqm7y4 logicalId: $App_Project_Manager pipelines: - id: "123456789" logicalId: $Pipeline_Data_Sync - id: "987654321" logicalId: $Pipeline_Notification_Flow x-amf-mediaType: application/json "400": description: "Bad request. For example: Missing required headers, Missing\ \ required parameters, Invalid solution ID format and others. Message\ \ should provide more information, reach out to support if there's lack\ \ of clarity." content: application/json: schema: type: object example: message: Bad request. description: "" x-amf-mediaType: application/json "404": description: Solution does not exist. The supplied solution ID was not found. content: application/json: schema: type: object example: message: Not found. description: "" x-amf-mediaType: application/json "500": description: Internal server error. An unexpected error occurred while processing the request. content: application/json: schema: type: object example: message: Internal server error. description: "" x-amf-mediaType: application/json "401": description: "Insufficient access. This could be for many reasons such as:\ \ User doesn't have SolutionHub access, User is not the owner or a contributor\ \ for the solution, User cannot access the solution and others. Message\ \ should provide more information." content: application/json: schema: type: object example: message: Forbidden. description: "" x-amf-mediaType: application/json /app/{appId}/trustees: get: tags: - Trustees summary: Get trustees for an app description: "Returns the list of trustees for a specific application. Trustees\ \ include users, groups and email domain groups." operationId: getTrustees parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: maxItems: 1000 minItems: 1 type: array description: "A list of trustees. Each trustee is represented by an\ \ object containing the trustee's ID, type, and role ID." example: - id: 123456.ab1s roleId: 10 type: user - id: 1002.czm8 roleId: 11 type: group items: required: - id - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain group\ \ to be added as a trustee. For users and groups, this is\ \ the user's or group's ID in Quickbase. For email domain\ \ groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 type: type: string description: "The type of trustee being added. This can be a\ \ user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create, or update\ \ trustees in an app." example: id: 123456.ab1s roleId: 10 type: user post: tags: - Trustees summary: Add trustees to an app description: "Add trustees to the specified application. Trustees include users,\ \ groups and email domain groups." operationId: addTrustees parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of trustees that were not updated. This includes invalid IDs or IDs that could not be processed. items: type: object properties: error: type: string description: The error message associated with the trustee that could not be updated. trustee: required: - id - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For\ \ email domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 type: type: string description: "The type of trustee being added. This\ \ can be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create,\ \ or update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user success: type: array description: A list of trustees that have been successfully updated. items: required: - id - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For email\ \ domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 type: type: string description: "The type of trustee being added. This can\ \ be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create, or\ \ update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user example: failure: [] success: - id: 123456.ab1s roleId: 10 type: user "207": description: "Partial success. Some trustees were added successfully, while\ \ others failed." content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of trustees that were not updated. This includes invalid IDs or IDs that could not be processed. items: type: object properties: error: type: string description: The error message associated with the trustee that could not be updated. trustee: required: - id - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For\ \ email domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 type: type: string description: "The type of trustee being added. This\ \ can be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create,\ \ or update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user success: type: array description: A list of trustees that have been successfully updated. items: required: - id - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For email\ \ domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 type: type: string description: "The type of trustee being added. This can\ \ be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create, or\ \ update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user example: failure: - error: Invalid user ID trustee: id: 78910.ba1s roleId: 12 type: user success: - id: 123456.ab1s roleId: 10 type: user x-codegen-request-body-name: generated delete: tags: - Trustees summary: Remove trustees from an app description: "Remove trustees from the specified application. Trustees include\ \ users, groups and email domain groups." operationId: removeTrustees parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of trustees that were not updated. This includes invalid IDs or IDs that could not be processed. items: type: object properties: error: type: string description: The error message associated with the trustee that could not be updated. trustee: required: - id - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For\ \ email domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 type: type: string description: "The type of trustee being added. This\ \ can be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create,\ \ or update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user success: type: array description: A list of trustees that have been successfully updated. items: required: - id - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For email\ \ domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 type: type: string description: "The type of trustee being added. This can\ \ be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create, or\ \ update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user example: failure: [] success: - id: 123456.ab1s roleId: 10 type: user "207": description: "Partial success. Some trustees were added successfully, while\ \ others failed." content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of trustees that were not updated. This includes invalid IDs or IDs that could not be processed. items: type: object properties: error: type: string description: The error message associated with the trustee that could not be updated. trustee: required: - id - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For\ \ email domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 type: type: string description: "The type of trustee being added. This\ \ can be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create,\ \ or update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user success: type: array description: A list of trustees that have been successfully updated. items: required: - id - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For email\ \ domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 type: type: string description: "The type of trustee being added. This can\ \ be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create, or\ \ update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user example: failure: - error: Invalid user ID trustee: id: 78910.ba1s roleId: 12 type: user success: - id: 123456.ab1s roleId: 10 type: user x-codegen-request-body-name: generated patch: tags: - Trustees summary: Update trustees of an app description: "Update trustees for the specified application. Trustees include\ \ users, groups and email domain groups." operationId: updateTrustees parameters: - name: appId in: path description: The unique identifier of an app required: true schema: type: string - name: QB-Realm-Hostname in: header description: "Your Quickbase domain, for example demo.quickbase.com" required: true schema: type: string - name: User-Agent in: header description: Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. schema: type: string responses: "200": description: Success content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of trustees that were not updated. This includes invalid IDs or IDs that could not be processed. items: type: object properties: error: type: string description: The error message associated with the trustee that could not be updated. trustee: required: - id - oldRoleId - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For\ \ email domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 oldRoleId: type: integer description: The ID of the role to be changed for the trustee. This is used to identify the current role before updating it. type: type: string description: "The type of trustee being added. This\ \ can be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create,\ \ or update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user success: type: array description: A list of trustees that have been successfully updated. items: required: - id - oldRoleId - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For email\ \ domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 oldRoleId: type: integer description: The ID of the role to be changed for the trustee. This is used to identify the current role before updating it. type: type: string description: "The type of trustee being added. This can\ \ be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create, or\ \ update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user example: failure: [] success: - id: 123456.ab1s oldRoleId: 15 roleId: 10 type: user "207": description: "Partial success. Some trustees were added successfully, while\ \ others failed." content: application/json: schema: required: - failure - success type: object properties: failure: type: array description: A list of trustees that were not updated. This includes invalid IDs or IDs that could not be processed. items: type: object properties: error: type: string description: The error message associated with the trustee that could not be updated. trustee: required: - id - oldRoleId - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For\ \ email domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 oldRoleId: type: integer description: The ID of the role to be changed for the trustee. This is used to identify the current role before updating it. type: type: string description: "The type of trustee being added. This\ \ can be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create,\ \ or update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user success: type: array description: A list of trustees that have been successfully updated. items: required: - id - oldRoleId - roleId - type type: object properties: id: type: string description: "The ID of the user, group, or email domain\ \ group to be added as a trustee. For users and groups,\ \ this is the user's or group's ID in Quickbase. For email\ \ domain groups, this is the email domain." example: 123456.ab1s roleId: type: integer description: The ID of the role to be assigned or currently assigned to the trustee. example: 10 oldRoleId: type: integer description: The ID of the role to be changed for the trustee. This is used to identify the current role before updating it. type: type: string description: "The type of trustee being added. This can\ \ be a user, group, or email domain group." example: user enum: - user - group - dom-group description: "Object used for operations to read, create, or\ \ update trustees in an app." example: id: 123456.ab1s roleId: 10 type: user example: failure: - error: Invalid user ID trustee: id: 78910.ba1s oldRoleId: 15 roleId: 12 type: user success: - id: 123456.ab1s oldRoleId: 15 roleId: 10 type: user x-codegen-request-body-name: generated components: securitySchemes: quickbaseAuth: type: apiKey in: header name: Authorization description: >- The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page. x-original-swagger-version: "2.0"