> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # quickbase-api > Quickbase API **Server path:** `/quickbase-api` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------- | --------------------------------- | | [`quickbase-api_add_managers_to_group`](#quickbase-api_add_managers_to_group) | Add managers | | [`quickbase-api_add_members_to_group`](#quickbase-api_add_members_to_group) | Add members | | [`quickbase-api_add_subgroups_to_group`](#quickbase-api_add_subgroups_to_group) | Add child groups | | [`quickbase-api_add_trustees`](#quickbase-api_add_trustees) | Add trustees to an app | | [`quickbase-api_audit`](#quickbase-api_audit) | Get audit logs | | [`quickbase-api_copy_app`](#quickbase-api_copy_app) | Copy an app | | [`quickbase-api_create_app`](#quickbase-api_create_app) | Create an app | | [`quickbase-api_create_field`](#quickbase-api_create_field) | Create a field | | [`quickbase-api_create_relationship`](#quickbase-api_create_relationship) | Create a relationship | | [`quickbase-api_create_table`](#quickbase-api_create_table) | Create a table | | [`quickbase-api_delete_fields`](#quickbase-api_delete_fields) | Delete field(s) | | [`quickbase-api_delete_file`](#quickbase-api_delete_file) | Delete file | | [`quickbase-api_delete_records`](#quickbase-api_delete_records) | Delete record(s) | | [`quickbase-api_delete_relationship`](#quickbase-api_delete_relationship) | Delete a relationship | | [`quickbase-api_delete_table`](#quickbase-api_delete_table) | Delete a table | | [`quickbase-api_deny_users`](#quickbase-api_deny_users) | Deny users | | [`quickbase-api_deny_users_and_groups`](#quickbase-api_deny_users_and_groups) | Deny and remove users from groups | | [`quickbase-api_download_file`](#quickbase-api_download_file) | Download file | | [`quickbase-api_generate_document`](#quickbase-api_generate_document) | Generate a document | | [`quickbase-api_get_app`](#quickbase-api_get_app) | Get an app | | [`quickbase-api_get_app_events`](#quickbase-api_get_app_events) | Get app events | | [`quickbase-api_get_app_tables`](#quickbase-api_get_app_tables) | Get tables for an app | | [`quickbase-api_get_field`](#quickbase-api_get_field) | Get field | | [`quickbase-api_get_field_usage`](#quickbase-api_get_field_usage) | Get usage for a field | | [`quickbase-api_get_fields`](#quickbase-api_get_fields) | Get fields for a table | | [`quickbase-api_get_fields_usage`](#quickbase-api_get_fields_usage) | Get usage for all fields | | [`quickbase-api_get_relationships`](#quickbase-api_get_relationships) | Get all relationships | | [`quickbase-api_get_report`](#quickbase-api_get_report) | Get a report | | [`quickbase-api_get_roles`](#quickbase-api_get_roles) | Get app roles | | [`quickbase-api_get_table`](#quickbase-api_get_table) | Get a table | | [`quickbase-api_get_table_reports`](#quickbase-api_get_table_reports) | Get reports for a table | | [`quickbase-api_get_trustees`](#quickbase-api_get_trustees) | Get trustees for an app | | [`quickbase-api_get_users`](#quickbase-api_get_users) | Get users | | [`quickbase-api_platform_analytic_event_summaries`](#quickbase-api_platform_analytic_event_summaries) | Get event summaries | | [`quickbase-api_platform_analytic_reads`](#quickbase-api_platform_analytic_reads) | Get read summaries | | [`quickbase-api_records_modified_since`](#quickbase-api_records_modified_since) | Get records modified since | | [`quickbase-api_remove_managers_from_group`](#quickbase-api_remove_managers_from_group) | Remove managers | | [`quickbase-api_remove_members_from_group`](#quickbase-api_remove_members_from_group) | Remove members | | [`quickbase-api_remove_subgroups_from_group`](#quickbase-api_remove_subgroups_from_group) | Remove child groups | | [`quickbase-api_remove_trustees`](#quickbase-api_remove_trustees) | Remove trustees from an app | | [`quickbase-api_run_formula`](#quickbase-api_run_formula) | Run a formula | | [`quickbase-api_run_query`](#quickbase-api_run_query) | Query for data | | [`quickbase-api_run_report`](#quickbase-api_run_report) | Run a report | | [`quickbase-api_undeny_users`](#quickbase-api_undeny_users) | Undeny users | | [`quickbase-api_update_app`](#quickbase-api_update_app) | Update an app | | [`quickbase-api_update_field`](#quickbase-api_update_field) | Update a field | | [`quickbase-api_update_relationship`](#quickbase-api_update_relationship) | Update a relationship | | [`quickbase-api_update_table`](#quickbase-api_update_table) | Update a table | | [`quickbase-api_update_trustees`](#quickbase-api_update_trustees) | Update trustees of an app | | [`quickbase-api_upsert`](#quickbase-api_upsert) | Insert/Update record(s) | *** ## quickbase-api\_add\_managers\_to\_group Add managers **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------------------------------------------- | | `gid` | number | Yes | — | This is the ID of the group being modified. | | `body` | string\[] | No | — | A list of user IDs that will be added to a group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "gid": { "type": "number", "description": "This is the ID of the group being modified." }, "body": { "type": "array", "items": { "type": "string" }, "description": "A list of user IDs that will be added to a group." } }, "required": [ "PCID", "gid" ] } ``` *** ## quickbase-api\_add\_members\_to\_group Add members **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------------------------------------------- | | `gid` | number | Yes | — | This is the ID of the group being modified. | | `body` | string\[] | No | — | A list of user IDs that will be added to a group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "gid": { "type": "number", "description": "This is the ID of the group being modified." }, "body": { "type": "array", "items": { "type": "string" }, "description": "A list of user IDs that will be added to a group." } }, "required": [ "PCID", "gid" ] } ``` *** ## quickbase-api\_add\_subgroups\_to\_group Add child groups **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | -------------------------------------------------- | | `gid` | number | Yes | — | This is the ID of the group being modified. | | `body` | string\[] | No | — | A list of group IDs that will be added to a group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "gid": { "type": "number", "description": "This is the ID of the group being modified." }, "body": { "type": "array", "items": { "type": "string" }, "description": "A list of group IDs that will be added to a group." } }, "required": [ "PCID", "gid" ] } ``` *** ## quickbase-api\_add\_trustees Add trustees to an app **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | | `body` | object\[] | No | — | A list of trustees. Each trustee is represented by an object containing the trustee's ID, type, and role ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." }, "body": { "type": "array", "items": { "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." }, "roleId": { "type": "integer", "description": "The ID of the role to be assigned or currently assigned to the trustee." }, "type": { "type": "string", "enum": [ "user", "group", "dom-group" ], "description": "The type of trustee being added. This can be a user, group, or email domain group." } }, "required": [ "id", "type", "roleId" ] }, "description": "A list of trustees. Each trustee is represented by an object containing the trustee's ID, type, and role ID." } }, "required": [ "PCID", "appId" ] } ``` *** ## quickbase-api\_audit Get audit logs **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `date` | string | No | — | The date for which audit logs need to be fetched. This must be date-time only, as YYYY-MM-DD, and a valid date in the past. | | `nextToken` | string | No | — | Token specifying start of page. For first page don't supply this. | | `numRows` | integer | No | — | Number of logs to return per page, default is 10000, minimum is 1000, max is 50000. | | `queryId` | string | No | — | The query id of an audit log request. This id is needed to fetch subsequent paged results of a single query. | | `topics` | string\[] | No | — | An array that may contain up to 20 [topics](https://resources.quickbase.com/nav/app/budurkasx/action/showpage/2b2941e4-f34d-4d41-9b0e-db790d20e9ab?pageIdV2=quickbase.com-DashboardGroup-15760d74-2243-4ce9-9495-7cc8790f12e7) to filter by. If empty, all topics are returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "date": { "type": "string", "description": "The date for which audit logs need to be fetched. This must be date-time only, as YYYY-MM-DD, and a valid date in the past." }, "nextToken": { "type": "string", "description": "Token specifying start of page. For first page don't supply this." }, "numRows": { "type": "integer", "description": "Number of logs to return per page, default is 10000, minimum is 1000, max is 50000." }, "queryId": { "type": "string", "description": "The query id of an audit log request. This id is needed to fetch subsequent paged results of a single query." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "An array that may contain up to 20 [topics](https://resources.quickbase.com/nav/app/budurkasx/action/showpage/2b2941e4-f34d-4d41-9b0e-db790d20e9ab?pageIdV2=quickbase.com-DashboardGroup-15760d74-2243-4ce9-9495-7cc8790f12e7) to filter by. If empty, all topics are returned." } }, "required": [ "PCID" ] } ``` *** ## quickbase-api\_copy\_app Copy an app **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | | `description` | string | No | — | The description of the newly copied app | | `name` | string | Yes | — | The name of the newly copied app | | `properties` | object | No | — | The configuration properties for performing the app copy | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." }, "description": { "type": "string", "description": "The description of the newly copied app" }, "name": { "type": "string", "description": "The name of the newly copied app" }, "properties": { "type": "object", "description": "The configuration properties for performing the app copy", "properties": { "assignUserToken": { "type": "boolean", "description": "Whether to add the user token used to make this request to the new app" }, "excludeFiles": { "type": "boolean", "description": "If keepData is true, whether to copy the file attachments as well. If keepData is false, this property is ignored" }, "keepData": { "type": "boolean", "description": "Whether to copy the app's data along with the schema" }, "usersAndRoles": { "type": "boolean", "description": "If true, users will be copied along with their assigned roles. If false, users and roles will be copied but roles will not be assigned" } } } }, "required": [ "PCID", "appId", "name" ] } ``` *** ## quickbase-api\_create\_app Create an app **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `assignToken` | boolean | No | — | 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. | | `description` | string | No | — | The description for the app. If this property is left out, the app description will be blank. | | `name` | string | Yes | — | 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` | object | No | — | Application security properties. | | `variables` | object\[] | No | — | 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) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "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." }, "description": { "type": "string", "description": "The description for the app. If this property is left out, the app description will be blank." }, "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", "description": "Application security properties.", "properties": { "hideFromPublic": { "type": "boolean", "description": "Hide from public application searches" }, "mustBeRealmApproved": { "type": "boolean", "description": "Only \"approved\" users may access this application" }, "allowClone": { "type": "boolean", "description": "Allow users who are not administrators to copy" }, "useIPFilter": { "type": "boolean", "description": "Only users logging in from \"approved\" IP addresses may access this application" }, "allowExport": { "type": "boolean", "description": "Allow users who are not administrators to export data" }, "enableAppTokens": { "type": "boolean", "description": "Require Application Tokens" } } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name for the variable." }, "value": { "type": "string", "description": "The value for the variable." } }, "required": [ "name", "value" ] }, "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)" } }, "required": [ "PCID", "name" ] } ``` *** ## quickbase-api\_create\_field Create a field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tableId` | string | Yes | — | The unique identifier of the table. | | `addToForms` | boolean | No | — | Whether the field you are adding should appear on forms. Defaults to false. | | `appearsByDefault` | boolean | No | — | Indicates if the field is marked as a default in reports. Defaults to true. | | `audited` | boolean | No | — | Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under [Quickbase Audit Logs](https://help.quickbase.com/docs/audit-logs). Defaults to false. | | `bold` | boolean | No | — | Indicates if the field is configured to display in bold in the product. Defaults to false. | | `fieldHelp` | string | No | — | The configured help text shown to users within the product. | | `fieldType` | string | Yes | — | The [field types](https://help.quickbase.com/docs/field-types), click on any of the field type links for more info. | | `findEnabled` | boolean | No | — | Indicates if the field is marked as searchable. Defaults to true. | | `label` | string | Yes | — | The label (name) of the field. | | `noWrap` | boolean | No | — | Indicates if the field is configured to not wrap when displayed in the product. Defaults to false. | | `permissions` | object\[] | No | — | Field Permissions for different roles. | | `properties` | object | No | — | Specific field properties. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier of the table." }, "addToForms": { "type": "boolean", "description": "Whether the field you are adding should appear on forms. Defaults to false." }, "appearsByDefault": { "type": "boolean", "description": "Indicates if the field is marked as a default in reports. Defaults to true." }, "audited": { "type": "boolean", "description": "Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to \"true\" if the app has audit logs enabled. See Enable data change logs under [Quickbase Audit Logs](https://help.quickbase.com/docs/audit-logs). Defaults to false." }, "bold": { "type": "boolean", "description": "Indicates if the field is configured to display in bold in the product. Defaults to false." }, "fieldHelp": { "type": "string", "description": "The configured help text shown to users within the product." }, "fieldType": { "type": "string", "description": "The [field types](https://help.quickbase.com/docs/field-types), click on any of the field type links for more info.", "enum": [ "text", "text-multiple-choice", "text-multi-line", "rich-text", "numeric", "currency", "rating", "percent", "multitext", "email", "url", "duration", "date", "datetime", "timestamp", "timeofday", "checkbox", "user", "multiuser", "address", "phone", "file" ] }, "findEnabled": { "type": "boolean", "description": "Indicates if the field is marked as searchable. Defaults to true." }, "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. Defaults to false." }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "description": "The role associated with a given permission for the field" }, "permissionType": { "type": "string", "description": "The permission given to the role for this field" }, "roleId": { "type": "integer", "description": "The Id of the given role" } } }, "description": "Field Permissions for different roles." }, "properties": { "type": "object", "description": "Specific field properties.", "properties": { "allowMentions": { "type": "boolean", "description": "If someone can @mention users in the rich text field to generate an email notification." }, "comments": { "type": "string", "description": "The comments entered on the field properties by an administrator." }, "doesTotal": { "type": "boolean", "description": "Whether this field totals in reports within the product." }, "autoSave": { "type": "boolean", "description": "Whether the link field will auto save." }, "defaultValueLuid": { "type": "integer", "description": "Default user id value." }, "useI18NFormat": { "type": "boolean", "description": "Whether phone numbers should be in E.164 standard international format" }, "maxVersions": { "type": "integer", "description": "The maximum number of versions configured for a file attachment." }, "format": { "type": "integer", "description": "The format to display time." }, "carryChoices": { "type": "boolean", "description": "Whether the field should carry its multiple choice fields when copied." }, "maxLength": { "type": "integer", "description": "The maximum number of characters allowed for entry in Quickbase for this field." }, "linkText": { "type": "string", "description": "The configured text value that replaces the URL that users see within the product." }, "parentFieldId": { "type": "integer", "description": "The id of the parent composite field, when applicable." }, "displayTimezone": { "type": "boolean", "description": "Indicates whether to display the timezone within the product." }, "allowNewChoices": { "type": "boolean", "description": "Indicates if users can add new choices to a selection list." }, "defaultToday": { "type": "boolean", "description": "Indicates if the field value is defaulted today for new records." }, "units": { "type": "string", "description": "The units label." }, "openTargetIn": { "type": "string", "description": "Indicates which target the URL should open in when a user clicks it within the product.", "enum": [ "sameWindow", "newWindow", "popup" ] }, "sourceFieldId": { "type": "integer", "description": "The id of the source field." }, "doesAverage": { "type": "boolean", "description": "Whether this field averages in reports within the product." }, "formula": { "type": "string", "description": "The formula of the field as configured in Quickbase." }, "decimalPlaces": { "type": "integer", "description": "The number of decimal places displayed in the product for this field." }, "defaultCountryCode": { "type": "string", "description": "Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format." }, "displayMonth": { "type": "string", "description": "How to display months." }, "seeVersions": { "type": "boolean", "description": "Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product." }, "numLines": { "type": "integer", "description": "The number of lines shown in Quickbase for this text field." }, "defaultKind": { "type": "string", "description": "The user default type." }, "displayEmail": { "type": "string", "description": "How the email is displayed." }, "coverText": { "type": "string", "description": "An alternate user friendly text that can be used to display a link in the browser." }, "currencySymbol": { "type": "string", "description": "The current symbol used when displaying field values within the product." }, "targetFieldId": { "type": "integer", "description": "The id of the target field." }, "displayUser": { "type": "string", "description": "The configured option for how users display within the product." }, "blankIsZero": { "type": "boolean", "description": "Whether a blank value is treated the same as 0 in calculations within the product." }, "exact": { "type": "boolean", "description": "Whether an exact match is required for a report link." }, "defaultDomain": { "type": "string", "description": "Default email domain." }, "defaultValue": { "type": "string", "description": "The default value configured for a field when a new record is added." }, "abbreviate": { "type": "boolean", "description": "Don't show the URL protocol when showing the URL." }, "numberFormat": { "type": "integer", "description": "The format used for displaying numeric values in the product (decimal, separators, digit group)." }, "targetTableName": { "type": "string", "description": "The field's target table name." }, "appearsAs": { "type": "string", "description": "The link text, if empty, the url will be used as link text." }, "width": { "type": "integer", "description": "The field's html input width in the product." }, "currencyFormat": { "type": "string", "description": "The currency format used when displaying field values within the product.", "enum": [ "left", "right", "middle" ] }, "displayDayOfWeek": { "type": "boolean", "description": "Indicates whether to display the day of the week within the product." }, "commaStart": { "type": "integer", "description": "The number of digits before commas display in the product, when applicable." }, "choices": { "type": "array", "items": { "type": "string" }, "description": "An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices." }, "targetTableId": { "type": "string", "description": "The id of the target table." }, "displayRelative": { "type": "boolean", "description": "Whether to display time as relative." }, "compositeFields": { "type": "array", "description": "An array of the fields that make up a composite field (e.g., address)." }, "displayCheckboxAsText": { "type": "boolean", "description": "Indicates whether the checkbox values will be shown as text in reports." }, "displayTime": { "type": "boolean", "description": "Indicates whether to display the time, in addition to the date." }, "versionMode": { "type": "string", "description": "Version modes for files. Keep all versions vs keep last version.", "enum": [ "keepallversions", "keeplastversions" ] }, "snapFieldId": { "type": "integer", "description": "The id of the field that is used to snapshot values from, when applicable." }, "hours24": { "type": "boolean", "description": "Indicates whether or not to display time in the 24-hour format within the product." }, "sortAlpha": { "type": "boolean", "description": "Whether to sort alphabetically, default sort is by record ID." }, "sortAsGiven": { "type": "boolean", "description": "Indicates if the listed entries sort as entered vs alphabetically." }, "hasExtension": { "type": "boolean", "description": "Whether this field has a phone extension." }, "useNewWindow": { "type": "boolean", "description": "Indicates if the file should open a new window when a user clicks it within the product." }, "postTempToken": { "type": "boolean", "description": "POSTs a temporary token to the first URL when clicked by a user. [Learn more](https://help.quickbase.com/docs/post-temporary-token-from-a-quickbase-field)" }, "appendOnly": { "type": "boolean", "description": "Whether this field is append only." }, "displayAsLink": { "type": "boolean", "description": "Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product." } } } }, "required": [ "PCID", "tableId", "fieldType", "label" ] } ``` *** ## quickbase-api\_create\_relationship Create a relationship **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ---------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. This will be the child table. | | `foreignKeyField` | object | No | — | This property is optional. If it is not provided, the foreign key field will be created with the label ‘Related \', where \ is the name of a record in the parent table. | | `lookupFieldIds` | integer\[] | No | — | Array of field IDs in the parent table that will become lookup fields in the child table. | | `parentTableId` | string | Yes | — | The parent table id for the relationship. | | `summaryFields` | object\[] | No | — | Array of summary field objects which will turn into summary fields in the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table. This will be the child table." }, "foreignKeyField": { "type": "object", "description": "This property is optional. If it is not provided, the foreign key field will be created with the label ‘Related ', where is the name of a record in the parent table.", "properties": { "label": { "type": "string", "description": "The label for the foreign key field." } } }, "lookupFieldIds": { "type": "array", "items": { "type": "integer" }, "description": "Array of field IDs in the parent table that will become lookup fields in the child table." }, "parentTableId": { "type": "string", "description": "The parent table id for the relationship." }, "summaryFields": { "type": "array", "items": { "type": "object", "properties": { "summaryFid": { "type": "number", "description": "The field id to summarize." }, "label": { "type": "string", "description": "The label for the summary field." }, "accumulationType": { "type": "string", "enum": [ "AVG", "SUM", "MAX", "MIN", "STD-DEV", "COUNT", "COMBINED-TEXT", "COMBINED-USER", "DISTINCT-COUNT" ], "description": "The accumulation type for the summary field." }, "where": { "type": "string", "description": "The filter, using the Quickbase query language, which determines the records to return." } }, "required": [ "accumulationType" ] }, "description": "Array of summary field objects which will turn into summary fields in the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid." } }, "required": [ "PCID", "tableId", "parentTableId" ] } ``` *** ## quickbase-api\_create\_table Create a table **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | | `description` | string | No | — | The description for the table. If this value is not passed the default value is blank. | | `name` | string | Yes | — | The name for the table. | | `pluralRecordName` | string | No | — | The plural noun for records in the table. If this value is not passed the default value is 'Records'. | | `singleRecordName` | string | No | — | The singular noun for records in the table. If this value is not passed the default value is 'Record'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." }, "description": { "type": "string", "description": "The description for the table. If this value is not passed the default value is blank." }, "name": { "type": "string", "description": "The name for the table." }, "pluralRecordName": { "type": "string", "description": "The plural noun for records in the table. If this value is not passed the default value is 'Records'." }, "singleRecordName": { "type": "string", "description": "The singular noun for records in the table. If this value is not passed the default value is 'Record'." } }, "required": [ "PCID", "appId", "name" ] } ``` *** ## quickbase-api\_delete\_fields Delete field(s) **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ---------- | -------- | ------- | ----------------------------------- | | `tableId` | string | Yes | — | The unique identifier of the table. | | `fieldIds` | integer\[] | Yes | — | List of field IDs to be deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier of the table." }, "fieldIds": { "type": "array", "items": { "type": "integer" }, "description": "List of field IDs to be deleted." } }, "required": [ "PCID", "tableId", "fieldIds" ] } ``` *** ## quickbase-api\_delete\_file Delete file **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------------------------ | | `tableId` | string | Yes | — | The unique identifier of the table. | | `recordId` | integer | Yes | — | The unique identifier of the record. | | `fieldId` | integer | Yes | — | The unique identifier of the field. | | `versionNumber` | integer | Yes | — | The file attachment version number. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier of the table." }, "recordId": { "type": "integer", "description": "The unique identifier of the record." }, "fieldId": { "type": "integer", "description": "The unique identifier of the field." }, "versionNumber": { "type": "integer", "description": "The file attachment version number." } }, "required": [ "PCID", "tableId", "recordId", "fieldId", "versionNumber" ] } ``` *** ## quickbase-api\_delete\_records Delete record(s) **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `from` | string | Yes | — | The unique identifier of the table. | | `where` | object | Yes | — | The filter to delete records. To delete all records specify a filter that will include all records, for example \{3.GT.0} where 3 is the ID of the Record ID field. Or supply a JSON array of Record IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "from": { "type": "string", "description": "The unique identifier of the table." }, "where": { "description": "The filter to delete records. To delete all records specify a filter that will include all records, for example {3.GT.0} where 3 is the ID of the Record ID field. Or supply a JSON array of Record IDs." } }, "required": [ "PCID", "from", "where" ] } ``` *** ## quickbase-api\_delete\_relationship Delete a relationship **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. This will be the child table. | | `relationshipId` | number | Yes | — | The relationship id. This is the field id of the reference field on the child table. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table. This will be the child table." }, "relationshipId": { "type": "number", "description": "The relationship id. This is the field id of the reference field on the child table." } }, "required": [ "PCID", "tableId", "relationshipId" ] } ``` *** ## quickbase-api\_delete\_table Delete a table **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table." } }, "required": [ "PCID", "appId", "tableId" ] } ``` *** ## quickbase-api\_deny\_users Deny users **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `accountId` | number | No | — | The account id being used to deny users. If no value is specified, the first account associated with the requesting user token is chosen. | | `body` | string\[] | No | — | A list of user IDs that need to be denied. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountId": { "type": "number", "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." }, "body": { "type": "array", "items": { "type": "string" }, "description": "A list of user IDs that need to be denied." } }, "required": [ "PCID" ] } ``` *** ## quickbase-api\_deny\_users\_and\_groups Deny and remove users from groups **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `accountId` | number | No | — | The account id being used to deny users. If no value is specified, the first account associated with the requesting user token is chosen. | | `shouldDeleteFromGroups` | boolean | Yes | — | Specifies if the users should also be removed from all groups. | | `body` | string\[] | No | — | A list of user IDs that need to be denied. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountId": { "type": "number", "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." }, "shouldDeleteFromGroups": { "type": "boolean", "description": "Specifies if the users should also be removed from all groups." }, "body": { "type": "array", "items": { "type": "string" }, "description": "A list of user IDs that need to be denied." } }, "required": [ "PCID", "shouldDeleteFromGroups" ] } ``` *** ## quickbase-api\_download\_file Download file **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------------------------ | | `tableId` | string | Yes | — | The unique identifier of the table. | | `recordId` | integer | Yes | — | The unique identifier of the record. | | `fieldId` | integer | Yes | — | The unique identifier of the field. | | `versionNumber` | integer | Yes | — | The file attachment version number. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier of the table." }, "recordId": { "type": "integer", "description": "The unique identifier of the record." }, "fieldId": { "type": "integer", "description": "The unique identifier of the field." }, "versionNumber": { "type": "integer", "description": "The file attachment version number." } }, "required": [ "PCID", "tableId", "recordId", "fieldId", "versionNumber" ] } ``` *** ## quickbase-api\_generate\_document Generate a document **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `templateId` | number | Yes | — | This is the ID of document template. | | `tableId` | string | Yes | — | The unique identifier of the table. | | `recordId` | number | No | — | The ID of the record | | `filename` | string | Yes | — | File name for the downloaded file | | `Accept` | string | No | — | The content-type of the response. application/json will return a JSON payload with a base64 encoded file. application/octet-stream will download the file directly. Only application/json is offered here — this connector reads responses as text, so a raw octet-stream download would corrupt binary output. | | `format` | string | No | — | The format of the file that is returned. Default is "pdf". | | `margin` | string | No | — | Margin formatted as top right bottom left, separated by spaces. Add to override the value set in the template builder. | | `unit` | string | No | — | Unit of measurement for the margin. Default is "in". Add to override the value set in the template builder. | | `pageSize` | string | No | — | Page size. Default is "A4". Add to override the value set in the template builder. | | `orientation` | string | No | — | Page orientation. Default is "portrait". Add to override the value set in the template builder. | | `realm` | string | No | — | Your Quickbase domain, for example demo.quickbase.com | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "templateId": { "type": "number", "description": "This is the ID of document template." }, "tableId": { "type": "string", "description": "The unique identifier of the table." }, "recordId": { "type": "number", "description": "The ID of the record" }, "filename": { "type": "string", "description": "File name for the downloaded file" }, "Accept": { "type": "string", "description": "The content-type of the response. application/json will return a JSON payload with a base64 encoded file. application/octet-stream will download the file directly. Only application/json is offered here — this connector reads responses as text, so a raw octet-stream download would corrupt binary output.", "enum": [ "application/json" ] }, "format": { "type": "string", "description": "The format of the file that is returned. Default is \"pdf\".", "enum": [ "html", "pdf", "docx" ] }, "margin": { "type": "string", "description": "Margin formatted as top right bottom left, separated by spaces. Add to override the value set in the template builder." }, "unit": { "type": "string", "description": "Unit of measurement for the margin. Default is \"in\". Add to override the value set in the template builder.", "enum": [ "in", "cm", "nm", "px" ] }, "pageSize": { "type": "string", "description": "Page size. Default is \"A4\". Add to override the value set in the template builder.", "enum": [ "Letter", "Legal", "Tabloid", "A3", "A4", "A5", "A6" ] }, "orientation": { "type": "string", "description": "Page orientation. Default is \"portrait\". Add to override the value set in the template builder.", "enum": [ "portrait", "landscape" ] }, "realm": { "type": "string", "description": "Your Quickbase domain, for example demo.quickbase.com" } }, "required": [ "PCID", "templateId", "tableId", "filename" ] } ``` *** ## quickbase-api\_get\_app Get an app **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." } }, "required": [ "PCID", "appId" ] } ``` *** ## quickbase-api\_get\_app\_events Get app events **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." } }, "required": [ "PCID", "appId" ] } ``` *** ## quickbase-api\_get\_app\_tables Get tables for an app **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." } }, "required": [ "PCID", "appId" ] } ``` *** ## quickbase-api\_get\_field Get field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------- | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. | | `includeFieldPerms` | boolean | No | — | Set to 'true' if you'd like to get back the custom permissions for the field(s). | | `fieldId` | integer | Yes | — | The unique identifier (fid) of the field. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table." }, "includeFieldPerms": { "type": "boolean", "description": "Set to 'true' if you'd like to get back the custom permissions for the field(s)." }, "fieldId": { "type": "integer", "description": "The unique identifier (fid) of the field." } }, "required": [ "PCID", "tableId", "fieldId" ] } ``` *** ## quickbase-api\_get\_field\_usage Get usage for a field **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------ | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. | | `fieldId` | integer | Yes | — | The unique identifier (fid) of the field. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table." }, "fieldId": { "type": "integer", "description": "The unique identifier (fid) of the field." } }, "required": [ "PCID", "tableId", "fieldId" ] } ``` *** ## quickbase-api\_get\_fields Get fields for a table **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------- | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. | | `includeFieldPerms` | boolean | No | — | Set to 'true' if you'd like to get back the custom permissions for the field(s). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table." }, "includeFieldPerms": { "type": "boolean", "description": "Set to 'true' if you'd like to get back the custom permissions for the field(s)." } }, "required": [ "PCID", "tableId" ] } ``` *** ## quickbase-api\_get\_fields\_usage Get usage for all fields **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------- | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. | | `skip` | integer | No | — | The number of fields to skip from the list. | | `top` | integer | No | — | The maximum number of fields to return. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table." }, "skip": { "type": "integer", "description": "The number of fields to skip from the list." }, "top": { "type": "integer", "description": "The maximum number of fields to return." } }, "required": [ "PCID", "tableId" ] } ``` *** ## quickbase-api\_get\_relationships Get all relationships **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------ | | `skip` | integer | No | — | The number of relationships to skip. | | `tableId` | string | Yes | — | The unique identifier (dbid) of the child table. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skip": { "type": "integer", "description": "The number of relationships to skip." }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the child table." } }, "required": [ "PCID", "tableId" ] } ``` *** ## quickbase-api\_get\_report Get a report **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | -------------------------------------------------- | | `tableId` | string | Yes | — | The unique identifier of table. | | `reportId` | string | Yes | — | The identifier of the report, unique to the table. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier of table." }, "reportId": { "type": "string", "description": "The identifier of the report, unique to the table." } }, "required": [ "PCID", "tableId", "reportId" ] } ``` *** ## quickbase-api\_get\_roles Get app roles **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." } }, "required": [ "PCID", "appId" ] } ``` *** ## quickbase-api\_get\_table Get a table **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table." } }, "required": [ "PCID", "appId", "tableId" ] } ``` *** ## quickbase-api\_get\_table\_reports Get reports for a table **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------- | | `tableId` | string | Yes | — | The unique identifier of the table. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier of the table." } }, "required": [ "PCID", "tableId" ] } ``` *** ## quickbase-api\_get\_trustees Get trustees for an app **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." } }, "required": [ "PCID", "appId" ] } ``` *** ## quickbase-api\_get\_users Get users **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountId` | number | No | — | The account id being used to get users. If no value is specified, the first account associated with the requesting user token is chosen. | | `appIds` | string\[] | No | — | When provided, the returned users will be narrowed down only to the users assigned to the app id's provided in this list. The provided app id's should belong to the same account. | | `emails` | string\[] | No | — | When provided, the returned users will be narrowed down only to the users included in this list. | | `nextPageToken` | string | No | — | Next page token used to get the next 'page' of results when available. When this field is empty, the first page is returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountId": { "type": "number", "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." }, "appIds": { "type": "array", "items": { "type": "string" }, "description": "When provided, the returned users will be narrowed down only to the users assigned to the app id's provided in this list. The provided app id's should belong to the same account." }, "emails": { "type": "array", "items": { "type": "string" }, "description": "When provided, the returned users will be narrowed down only to the users included in this list." }, "nextPageToken": { "type": "string", "description": "Next page token used to get the next 'page' of results when available. When this field is empty, the first page is returned." } }, "required": [ "PCID" ] } ``` *** ## quickbase-api\_platform\_analytic\_event\_summaries Get event summaries **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- | | `accountId` | number | No | — | The ID of the account to query. If no value is specified, the first account matching the provided domain is chosen. | | `end` | string | Yes | — | The end date and time of the requested summaries in ISO 8601 time format. | | `groupBy` | string | Yes | — | How the events should be grouped. | | `nextToken` | string | No | — | A pagination token from a previous response made using the same parameters. Used to fetch the next page. | | `start` | string | Yes | — | The start date and time of the requested summaries in ISO 8601 time format. | | `where` | object\[] | No | — | A list of items to filter events by. Only events which match ALL criteria will be included in the results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountId": { "type": "number", "description": "The ID of the account to query. If no value is specified, the first account matching the provided domain is chosen." }, "end": { "type": "string", "description": "The end date and time of the requested summaries in ISO 8601 time format." }, "groupBy": { "type": "string", "description": "How the events should be grouped.", "enum": [ "app", "user" ] }, "nextToken": { "type": "string", "description": "A pagination token from a previous response made using the same parameters. Used to fetch the next page." }, "start": { "type": "string", "description": "The start date and time of the requested summaries in ISO 8601 time format." }, "where": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the item to filter by - the hash uid if filtering a user, or the app id if filtering an app." }, "type": { "type": "string", "enum": [ "app", "user" ], "description": "The type of item to filter by." } }, "required": [ "id", "type" ] }, "description": "A list of items to filter events by. Only events which match ALL criteria will be included in the results." } }, "required": [ "PCID", "end", "groupBy", "start" ] } ``` *** ## quickbase-api\_platform\_analytic\_reads Get read summaries **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- | | `day` | string | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "day": { "type": "string", "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." } }, "required": [ "PCID" ] } ``` *** ## quickbase-api\_records\_modified\_since Get records modified since **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `after` | string | Yes | — | A timestamp, formatted in ISO-8601 UTC, representing the date and time to search. | | `fieldList` | integer\[] | No | — | List of field IDs. Each field is crawled across the entire record dependency graph to find its source record's date modified. If one is not provided, only the current table will be referenced. | | `from` | string | Yes | — | The table identifier. | | `includeDetails` | boolean | No | — | When true, the individual record IDs and timestamps will be returned. If false, only the count of changes will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "after": { "type": "string", "description": "A timestamp, formatted in ISO-8601 UTC, representing the date and time to search." }, "fieldList": { "type": "array", "items": { "type": "integer" }, "description": "List of field IDs. Each field is crawled across the entire record dependency graph to find its source record's date modified. If one is not provided, only the current table will be referenced." }, "from": { "type": "string", "description": "The table identifier." }, "includeDetails": { "type": "boolean", "description": "When true, the individual record IDs and timestamps will be returned. If false, only the count of changes will be returned." } }, "required": [ "PCID", "after", "from" ] } ``` *** ## quickbase-api\_remove\_managers\_from\_group Remove managers **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ----------------------------------------------------- | | `gid` | number | Yes | — | This is the ID of the group being modified. | | `body` | string\[] | No | — | A list of user IDs that will be removed from a group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "gid": { "type": "number", "description": "This is the ID of the group being modified." }, "body": { "type": "array", "items": { "type": "string" }, "description": "A list of user IDs that will be removed from a group." } }, "required": [ "PCID", "gid" ] } ``` *** ## quickbase-api\_remove\_members\_from\_group Remove members **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ----------------------------------------------------- | | `gid` | number | Yes | — | This is the ID of the group being modified. | | `body` | string\[] | No | — | A list of user IDs that will be removed from a group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "gid": { "type": "number", "description": "This is the ID of the group being modified." }, "body": { "type": "array", "items": { "type": "string" }, "description": "A list of user IDs that will be removed from a group." } }, "required": [ "PCID", "gid" ] } ``` *** ## quickbase-api\_remove\_subgroups\_from\_group Remove child groups **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------------------------------------------------ | | `gid` | number | Yes | — | This is the ID of the group being modified. | | `body` | string\[] | No | — | A list of group IDs that will be removed from a group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "gid": { "type": "number", "description": "This is the ID of the group being modified." }, "body": { "type": "array", "items": { "type": "string" }, "description": "A list of group IDs that will be removed from a group." } }, "required": [ "PCID", "gid" ] } ``` *** ## quickbase-api\_remove\_trustees Remove trustees from an app **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | | `body` | object\[] | No | — | A list of trustees. Each trustee is represented by an object containing the trustee's ID, type, and role ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." }, "body": { "type": "array", "items": { "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." }, "roleId": { "type": "integer", "description": "The ID of the role to be assigned or currently assigned to the trustee." }, "type": { "type": "string", "enum": [ "user", "group", "dom-group" ], "description": "The type of trustee being added. This can be a user, group, or email domain group." } }, "required": [ "id", "type", "roleId" ] }, "description": "A list of trustees. Each trustee is represented by an object containing the trustee's ID, type, and role ID." } }, "required": [ "PCID", "appId" ] } ``` *** ## quickbase-api\_run\_formula Run a formula **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `formula` | string | Yes | — | The formula to run. This must be a valid Quickbase formula. | | `from` | string | Yes | — | The unique identifier (dbid) of the table. | | `rid` | integer | No | — | The record ID to run the formula against. Only necessary for formulas that are run in the context of a record. For example, the formula User() does not need a record ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "formula": { "type": "string", "description": "The formula to run. This must be a valid Quickbase formula." }, "from": { "type": "string", "description": "The unique identifier (dbid) of the table." }, "rid": { "type": "integer", "description": "The record ID to run the formula against. Only necessary for formulas that are run in the context of a record. For example, the formula User() does not need a record ID." } }, "required": [ "PCID", "formula", "from" ] } ``` *** ## quickbase-api\_run\_query Query for data **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `from` | string | Yes | — | The table identifier. | | `groupBy` | object\[] | No | — | An array that contains the fields to group the records by. | | `options` | object | No | — | Additional query options. | | `select` | any\[] | No | — | An array of field IDs for the fields that should be returned in the response. If empty, the default columns on the table will be returned. | | `sortBy` | object | No | — | An array of field IDs and sort directions. If this attribute is not set or set to false, queries will be unsorted to improve performance. | | `where` | object | No | — | The filter, using the Quickbase query language, which determines the records to return. Or supply a JSON array of Record IDs. If this parameter is omitted, the query will return all records. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "from": { "type": "string", "description": "The table identifier." }, "groupBy": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "integer", "description": "The unique identifier of a field in a table." }, "grouping": { "type": "string", "enum": [ "equal-values" ], "description": "Group by based on equal values (equal-values)" } } }, "description": "An array that contains the fields to group the records by." }, "options": { "type": "object", "description": "Additional query options.", "properties": { "skip": { "type": "integer", "description": "The number of records to skip." }, "compareWithAppLocalTime": { "type": "boolean", "description": "Whether to run the query against a date time field with respect to the application's local time. The query is run with UTC time by default. This parameter is ignored when querying by ISO8601, which is always in UTC." }, "top": { "type": "integer", "description": "The maximum number of records to display." } } }, "select": { "type": "array", "description": "An array of field IDs for the fields that should be returned in the response. If empty, the default columns on the table will be returned." }, "sortBy": { "description": "An array of field IDs and sort directions. If this attribute is not set or set to false, queries will be unsorted to improve performance." }, "where": { "description": "The filter, using the Quickbase query language, which determines the records to return. Or supply a JSON array of Record IDs. If this parameter is omitted, the query will return all records." } }, "required": [ "PCID", "from" ] } ``` *** ## quickbase-api\_run\_report Run a report **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tableId` | string | Yes | — | The identifier of the table for the report. | | `skip` | integer | No | — | The number of records to skip. You can set this value when paginating through a set of results. | | `top` | integer | No | — | The maximum number of records to return. You can override the default Quickbase pagination to get more or fewer results. If your requested value here exceeds the dynamic maximums, we will return a subset of results and the rest can be gathered in subsequent API calls. | | `reportId` | string | Yes | — | The identifier of the report, unique to the table. | | `body` | object | No | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The identifier of the table for the report." }, "skip": { "type": "integer", "description": "The number of records to skip. You can set this value when paginating through a set of results." }, "top": { "type": "integer", "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." }, "reportId": { "type": "string", "description": "The identifier of the report, unique to the table." }, "body": { "description": "Request body" } }, "required": [ "PCID", "tableId", "reportId" ] } ``` *** ## quickbase-api\_undeny\_users Undeny users **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `accountId` | number | No | — | The account id being used to undeny users. If no value is specified, the first account associated with the requesting user token is chosen. | | `body` | string\[] | No | — | A list of user IDs that need to be undenied. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "accountId": { "type": "number", "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." }, "body": { "type": "array", "items": { "type": "string" }, "description": "A list of user IDs that need to be undenied." } }, "required": [ "PCID" ] } ``` *** ## quickbase-api\_update\_app Update an app **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | | `description` | string | No | — | The description for the app. | | `name` | string | No | — | The name for the app. | | `securityProperties` | object | No | — | Security properties of the application | | `variables` | object\[] | No | — | The app variables. A maximum of 10 variables can be updated at a time. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." }, "description": { "type": "string", "description": "The description for the app." }, "name": { "type": "string", "description": "The name for the app." }, "securityProperties": { "type": "object", "description": "Security properties of the application", "properties": { "hideFromPublic": { "type": "boolean", "description": "Hide from public application searches" }, "mustBeRealmApproved": { "type": "boolean", "description": "Only \"approved\" users may access this application" }, "allowClone": { "type": "boolean", "description": "Allow users who are not administrators to copy" }, "useIPFilter": { "type": "boolean", "description": "Only users logging in from \"approved\" IP addresses may access this application" }, "allowExport": { "type": "boolean", "description": "Allow users who are not administrators to export data" }, "enableAppTokens": { "type": "boolean", "description": "Require Application Tokens" } } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name for the variable." }, "value": { "type": "string", "description": "The value for the variable." } }, "required": [ "name", "value" ] }, "description": "The app variables. A maximum of 10 variables can be updated at a time. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)" } }, "required": [ "PCID", "appId" ] } ``` *** ## quickbase-api\_update\_field Update a field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tableId` | string | Yes | — | The unique identifier of the table. | | `fieldId` | integer | Yes | — | The unique identifier (fid) of the field. | | `addToForms` | boolean | No | — | Whether the field you are adding should appear on forms. | | `appearsByDefault` | boolean | No | — | Indicates if the field is marked as a default in reports. | | `audited` | boolean | No | — | Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under [Quickbase Audit Logs](https://help.quickbase.com/user-assistance/audit_logs.html). | | `bold` | boolean | No | — | Indicates if the field is configured to display in bold in the product. | | `fieldHelp` | string | No | — | The configured help text shown to users within the product. | | `findEnabled` | boolean | No | — | Indicates if the field is marked as searchable. | | `label` | string | No | — | The label (name) of the field. | | `noWrap` | boolean | No | — | Indicates if the field is configured to not wrap when displayed in the product. | | `permissions` | object\[] | No | — | Field Permissions for different roles. | | `properties` | object | No | — | Specific field properties. | | `required` | boolean | No | — | Indicates if the field is required (i.e. if every record must have a non-null value in this field). If you attempt to change a field from not-required to required, and the table currently contains records that have null values in that field, you will get an error indicating that there are null values of the field. In this case you need to find and update those records with null values of the field before changing the field to required. | | `unique` | boolean | No | — | Indicates if every record in the table must contain a unique value of this field. If you attempt to change a field from not-unique to unique, and the table currently contains records with the same value of this field, you will get an error. In this case you need to find and update those records with duplicate values of the field before changing the field to unique. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier of the table." }, "fieldId": { "type": "integer", "description": "The unique identifier (fid) of the field." }, "addToForms": { "type": "boolean", "description": "Whether the field you are adding should appear on forms." }, "appearsByDefault": { "type": "boolean", "description": "Indicates if the field is marked as a default in reports." }, "audited": { "type": "boolean", "description": "Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to \"true\" if the app has audit logs enabled. See Enable data change logs under [Quickbase Audit Logs](https://help.quickbase.com/user-assistance/audit_logs.html)." }, "bold": { "type": "boolean", "description": "Indicates if the field is configured to display in bold in the product." }, "fieldHelp": { "type": "string", "description": "The configured help text shown to users within the product." }, "findEnabled": { "type": "boolean", "description": "Indicates if the field is marked as searchable." }, "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." }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "description": "The role associated with a given permission for the field" }, "permissionType": { "type": "string", "description": "The permission given to the role for this field" }, "roleId": { "type": "integer", "description": "The Id of the given role" } } }, "description": "Field Permissions for different roles." }, "properties": { "type": "object", "description": "Specific field properties.", "properties": { "allowMentions": { "type": "boolean", "description": "If someone can @mention users in the rich text field to generate an email notification." }, "comments": { "type": "string", "description": "The comments entered on the field properties by an administrator." }, "doesTotal": { "type": "boolean", "description": "Whether this field totals in reports within the product." }, "autoSave": { "type": "boolean", "description": "Whether the link field will auto save." }, "defaultValueLuid": { "type": "integer", "description": "Default user id value." }, "useI18NFormat": { "type": "boolean", "description": "Whether phone numbers should be in E.164 standard international format" }, "maxVersions": { "type": "integer", "description": "The maximum number of versions configured for a file attachment." }, "format": { "type": "integer", "description": "The format to display time." }, "carryChoices": { "type": "boolean", "description": "Whether the field should carry its multiple choice fields when copied." }, "maxLength": { "type": "integer", "description": "The maximum number of characters allowed for entry in Quickbase for this field." }, "linkText": { "type": "string", "description": "The configured text value that replaces the URL that users see within the product." }, "parentFieldId": { "type": "integer", "description": "The id of the parent composite field, when applicable." }, "displayTimezone": { "type": "boolean", "description": "Indicates whether to display the timezone within the product." }, "summaryTargetFieldId": { "type": "integer", "description": "The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn't require a field selection (like count)." }, "allowNewChoices": { "type": "boolean", "description": "Indicates if users can add new choices to a selection list." }, "defaultToday": { "type": "boolean", "description": "Indicates if the field value is defaulted today for new records." }, "units": { "type": "string", "description": "The units label." }, "openTargetIn": { "type": "string", "description": "Indicates which target the URL should open in when a user clicks it within the product.", "enum": [ "sameWindow", "newWindow", "popup" ] }, "lookupTargetFieldId": { "type": "integer", "description": "The id of the field that is the target on the parent table for this lookup." }, "summaryFunction": { "type": "string", "description": "The accumulation type for the summary field.", "enum": [ "AVG", "SUM", "MAX", "MIN", "STD-DEV", "COUNT", "COMBINED-TEXT", "COMBINED-USER", "DISTINCT-COUNT" ] }, "sourceFieldId": { "type": "integer", "description": "The id of the source field." }, "doesAverage": { "type": "boolean", "description": "Whether this field averages in reports within the product." }, "formula": { "type": "string", "description": "The formula of the field as configured in Quickbase." }, "decimalPlaces": { "type": "integer", "description": "The number of decimal places displayed in the product for this field." }, "defaultCountryCode": { "type": "string", "description": "Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format." }, "displayMonth": { "type": "string", "description": "How to display months." }, "seeVersions": { "type": "boolean", "description": "Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product." }, "numLines": { "type": "integer", "description": "The number of lines shown in Quickbase for this text field." }, "defaultKind": { "type": "string", "description": "The user default type." }, "displayEmail": { "type": "string", "description": "How the email is displayed." }, "coverText": { "type": "string", "description": "An alternate user friendly text that can be used to display a link in the browser." }, "currencySymbol": { "type": "string", "description": "The current symbol used when displaying field values within the product." }, "summaryQuery": { "type": "string", "description": "The summary query." }, "targetFieldId": { "type": "integer", "description": "The id of the target field." }, "displayUser": { "type": "string", "description": "The configured option for how users display within the product." }, "blankIsZero": { "type": "boolean", "description": "Whether a blank value is treated the same as 0 in calculations within the product." }, "exact": { "type": "boolean", "description": "Whether an exact match is required for a report link." }, "defaultDomain": { "type": "string", "description": "Default email domain." }, "defaultValue": { "type": "string", "description": "The default value configured for a field when a new record is added." }, "abbreviate": { "type": "boolean", "description": "Don't show the URL protocol when showing the URL." }, "numberFormat": { "type": "integer", "description": "The format used for displaying numeric values in the product (decimal, separators, digit group)." }, "targetTableName": { "type": "string", "description": "The field's target table name." }, "appearsAs": { "type": "string", "description": "The link text, if empty, the url will be used as link text." }, "width": { "type": "integer", "description": "The field's html input width in the product." }, "currencyFormat": { "type": "string", "description": "The currency format used when displaying field values within the product.", "enum": [ "left", "right", "middle" ] }, "displayDayOfWeek": { "type": "boolean", "description": "Indicates whether to display the day of the week within the product." }, "summaryReferenceFieldId": { "type": "integer", "description": "The id of the field that is the reference in the relationship for this summary." }, "commaStart": { "type": "integer", "description": "The number of digits before commas display in the product, when applicable." }, "choices": { "type": "array", "items": { "type": "string" }, "description": "An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices." }, "targetTableId": { "type": "string", "description": "The id of the target table." }, "displayRelative": { "type": "boolean", "description": "Whether to display time as relative." }, "compositeFields": { "type": "array", "description": "An array of the fields that make up a composite field (e.g., address)." }, "displayCheckboxAsText": { "type": "boolean", "description": "Indicates whether the checkbox values will be shown as text in reports." }, "summaryTableId": { "type": "string", "description": "The table the summary field references fields from." }, "displayTime": { "type": "boolean", "description": "Indicates whether to display the time, in addition to the date." }, "versionMode": { "type": "string", "description": "Version modes for files. Keep all versions vs keep last version.", "enum": [ "keepallversions", "keeplastversions" ] }, "snapFieldId": { "type": "integer", "description": "The id of the field that is used to snapshot values from, when applicable." }, "hours24": { "type": "boolean", "description": "Indicates whether or not to display time in the 24-hour format within the product." }, "sortAlpha": { "type": "boolean", "description": "Whether to sort alphabetically, default sort is by record ID." }, "sortAsGiven": { "type": "boolean", "description": "Indicates if the listed entries sort as entered vs alphabetically." }, "hasExtension": { "type": "boolean", "description": "Whether this field has a phone extension." }, "useNewWindow": { "type": "boolean", "description": "Indicates if the file should open a new window when a user clicks it within the product." }, "postTempToken": { "type": "boolean", "description": "POSTs a temporary token to the first URL when clicked by a user. [Learn more](https://help.quickbase.com/docs/post-temporary-token-from-a-quickbase-field)" }, "appendOnly": { "type": "boolean", "description": "Whether this field is append only." }, "displayAsLink": { "type": "boolean", "description": "Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product." }, "lookupReferenceFieldId": { "type": "integer", "description": "The id of the field that is the reference in the relationship for this lookup." } } }, "required": { "type": "boolean", "description": "Indicates if the field is required (i.e. if every record must have a non-null value in this field). If you attempt to change a field from not-required to required, and the table currently contains records that have null values in that field, you will get an error indicating that there are null values of the field. In this case you need to find and update those records with null values of the field before changing the field to required." }, "unique": { "type": "boolean", "description": "Indicates if every record in the table must contain a unique value of this field. If you attempt to change a field from not-unique to unique, and the table currently contains records with the same value of this field, you will get an error. In this case you need to find and update those records with duplicate values of the field before changing the field to unique." } }, "required": [ "PCID", "tableId", "fieldId" ] } ``` *** ## quickbase-api\_update\_relationship Update a relationship **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ---------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. This will be the child table. | | `relationshipId` | number | Yes | — | The relationship id. This is the field id of the reference field on the child table. | | `lookupFieldIds` | integer\[] | No | — | An array of field IDs on the parent table that will become lookup fields on the child table. | | `summaryFields` | object\[] | No | — | An array of objects, each representing a configuration of one field from the child table, that will become summary fields on the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table. This will be the child table." }, "relationshipId": { "type": "number", "description": "The relationship id. This is the field id of the reference field on the child table." }, "lookupFieldIds": { "type": "array", "items": { "type": "integer" }, "description": "An array of field IDs on the parent table that will become lookup fields on the child table." }, "summaryFields": { "type": "array", "items": { "type": "object", "properties": { "summaryFid": { "type": "number", "description": "The field id to summarize." }, "label": { "type": "string", "description": "The label for the summary field." }, "accumulationType": { "type": "string", "enum": [ "AVG", "SUM", "MAX", "MIN", "STD-DEV", "COUNT", "COMBINED-TEXT", "COMBINED-USER", "DISTINCT-COUNT" ], "description": "The accumulation type for the summary field." }, "where": { "type": "string", "description": "The filter, using the Quickbase query language, which determines the records to return." } }, "required": [ "accumulationType" ] }, "description": "An array of objects, each representing a configuration of one field from the child table, that will become summary fields on the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid." } }, "required": [ "PCID", "tableId", "relationshipId" ] } ``` *** ## quickbase-api\_update\_table Update a table **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | | `tableId` | string | Yes | — | The unique identifier (dbid) of the table. | | `description` | string | No | — | The description for the table. If this value is not passed the default value is blank. | | `name` | string | No | — | The name for the table. | | `pluralRecordName` | string | No | — | The plural noun for records in the table. If this value is not passed the default value is 'Records'. | | `singleRecordName` | string | No | — | The singular noun for records in the table. If this value is not passed the default value is 'Record'. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." }, "tableId": { "type": "string", "description": "The unique identifier (dbid) of the table." }, "description": { "type": "string", "description": "The description for the table. If this value is not passed the default value is blank." }, "name": { "type": "string", "description": "The name for the table." }, "pluralRecordName": { "type": "string", "description": "The plural noun for records in the table. If this value is not passed the default value is 'Records'." }, "singleRecordName": { "type": "string", "description": "The singular noun for records in the table. If this value is not passed the default value is 'Record'." } }, "required": [ "PCID", "appId", "tableId" ] } ``` *** ## quickbase-api\_update\_trustees Update trustees of an app **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `appId` | string | Yes | — | The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection. | | `body` | object\[] | No | — | A list of trustees to be updated in an app. Each trustee is represented by an object containing the trustee's ID, type, and role ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appId": { "type": "string", "description": "The unique identifier of an app. Pass the literal value `_appId_` to target the Quickbase application configured on this connection." }, "body": { "type": "array", "items": { "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." }, "roleId": { "type": "integer", "description": "The ID of the role to be assigned or currently assigned to the trustee." }, "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", "enum": [ "user", "group", "dom-group" ], "description": "The type of trustee being added. This can be a user, group, or email domain group." } }, "required": [ "id", "type", "roleId", "oldRoleId" ] }, "description": "A list of trustees to be updated in an app. Each trustee is represented by an object containing the trustee's ID, type, and role ID." } }, "required": [ "PCID", "appId" ] } ``` *** ## quickbase-api\_upsert Insert/Update record(s) **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `data` | any\[] | No | — | Record data array, where each record contains key-value mappings of fields to be defined/updated and their values. | | `fieldsToReturn` | integer\[] | No | — | Specify an array of field IDs that will return data for any updates or added record. Record ID (FID 3) is always returned if any field ID is requested. | | `mergeFieldId` | integer | No | — | The merge field id. | | `to` | string | Yes | — | The table identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "data": { "type": "array", "description": "Record data array, where each record contains key-value mappings of fields to be defined/updated and their values." }, "fieldsToReturn": { "type": "array", "items": { "type": "integer" }, "description": "Specify an array of field IDs that will return data for any updates or added record. Record ID (FID 3) is always returned if any field ID is requested." }, "mergeFieldId": { "type": "integer", "description": "The merge field id." }, "to": { "type": "string", "description": "The table identifier." } }, "required": [ "PCID", "to" ] } ```