Quickbase

Methods (67)

• listApps

  read

  List every app the current user token has been granted access to (via legacy XML API).

  Input schema

  {
    "type": "object",
    "properties": {
      "withEmbeddedTables": {
        "type": "boolean"
      },
      "excludeParents": {
        "type": "boolean"
      },
      "adminOnly": {
        "type": "boolean"
      }
    },
    "additionalProperties": false
  }

• createApp

  write

  Create an app

  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• getApp

  read

  Retrieve the settings and metadata of one application by application id.

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": false,
    "required": [
      "appId"
    ]
  }

• updateApp

  write

  Update an app

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": true,
    "required": [
      "appId"
    ]
  }

• deleteApp

  write

  Delete an app

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": false,
    "required": [
      "appId"
    ]
  }

• getAppEvents

  read

  Get app events

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": false,
    "required": [
      "appId"
    ]
  }

• copyApp

  unknown

  Copy an application, creating a new application from an existing one.

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": true,
    "required": [
      "appId"
    ]
  }

• getRoles

  read

  Get app roles

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": false,
    "required": [
      "appId"
    ]
  }

• getAppTables

  read

  Get tables for an app

  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": false
  }

• createTable

  write

  Create a table (Quickbase).

  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": true
  }

• getTable

  read

  Retrieve the definition and settings of one table within an application.

  Required paramstableId
  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "appId": {}
    },
    "additionalProperties": false,
    "required": [
      "tableId"
    ]
  }

• updateTable

  write

  Update a table (Quickbase).

  Required paramstableId
  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "appId": {}
    },
    "additionalProperties": true,
    "required": [
      "tableId"
    ]
  }

• deleteTable

  write

  Delete a table (Quickbase).

  Required paramstableId
  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "appId": {}
    },
    "additionalProperties": false,
    "required": [
      "tableId"
    ]
  }

• getRelationships

  read

  Get all relationships (Quickbase).

  Required paramstableId
  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "skip": {}
    },
    "additionalProperties": false,
    "required": [
      "tableId"
    ]
  }

• createRelationship

  write

  Create a relationship

  Required paramstableId
  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {}
    },
    "additionalProperties": true,
    "required": [
      "tableId"
    ]
  }

• updateRelationship

  write

  Update a relationship

  Required paramstableIdrelationshipId
  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "relationshipId": {}
    },
    "additionalProperties": true,
    "required": [
      "tableId",
      "relationshipId"
    ]
  }

• deleteRelationship

  write

  Delete a relationship

  Required paramstableIdrelationshipId
  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "relationshipId": {}
    },
    "additionalProperties": false,
    "required": [
      "tableId",
      "relationshipId"
    ]
  }

• getTableReports

  read

  Get reports for a table (Quickbase).

  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {}
    },
    "additionalProperties": false
  }

• getReport

  read

  Get a report (Quickbase).

  Required paramsreportId
  Input schema

  {
    "type": "object",
    "properties": {
      "reportId": {},
      "tableId": {}
    },
    "additionalProperties": false,
    "required": [
      "reportId"
    ]
  }

• runReport

  read

  Run a report

  Required paramsreportId

  Entitiesreport
  Input schema

  {
    "type": "object",
    "properties": {
      "reportId": {},
      "tableId": {},
      "skip": {},
      "top": {}
    },
    "additionalProperties": true,
    "required": [
      "reportId"
    ]
  }

• getFields

  read

  Get fields for a table (Quickbase).

  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "includeFieldPerms": {}
    },
    "additionalProperties": false
  }

• createField

  write

  Create a field

  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {}
    },
    "additionalProperties": true
  }

• deleteFields

  write

  Delete field(s)

  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {}
    },
    "additionalProperties": false
  }

• getField

  read

  Retrieve the definition, type, and optional permissions of one table field.

  Required paramsfieldId
  Input schema

  {
    "type": "object",
    "properties": {
      "fieldId": {},
      "tableId": {},
      "includeFieldPerms": {}
    },
    "additionalProperties": false,
    "required": [
      "fieldId"
    ]
  }

• updateField

  write

  Update a field (Quickbase).

  Required paramsfieldId
  Input schema

  {
    "type": "object",
    "properties": {
      "fieldId": {},
      "tableId": {}
    },
    "additionalProperties": true,
    "required": [
      "fieldId"
    ]
  }

• getFieldsUsage

  read

  Get usage for all fields

  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "skip": {},
      "top": {}
    },
    "additionalProperties": false
  }

• getFieldUsage

  read

  Get usage for a field

  Required paramsfieldId
  Input schema

  {
    "type": "object",
    "properties": {
      "fieldId": {},
      "tableId": {}
    },
    "additionalProperties": false,
    "required": [
      "fieldId"
    ]
  }

• runFormula

  read

  Run a formula

  Entitiesformula
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• upsert

  write

  Insert/Update record(s)

  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• deleteRecords

  write

  Delete record(s) (Quickbase).

  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }

• runQuery

  read

  Query for data (Quickbase).

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• recordsModifiedSince

  unknown

  Get records modified since

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• getTempTokenDBID

  read

  Get a temporary token for a dbid

  Required paramsdbid
  Input schema

  {
    "type": "object",
    "properties": {
      "dbid": {}
    },
    "additionalProperties": false,
    "required": [
      "dbid"
    ]
  }

• exchangeSsoToken

  unknown

  Exchange an SSO token

  Entitiestoken
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• cloneUserToken

  unknown

  Clone a user token

  Entitiestoken
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• transferUserToken

  unknown

  Transfer a user token

  Entitiestoken
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• deactivateUserToken

  unknown

  Deactivate a user token

  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• deleteUserToken

  write

  Delete a user token

  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }

• downloadFile

  read

  Download file

  Required paramstableIdrecordIdfieldIdversionNumber
  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "recordId": {},
      "fieldId": {},
      "versionNumber": {}
    },
    "additionalProperties": false,
    "required": [
      "tableId",
      "recordId",
      "fieldId",
      "versionNumber"
    ]
  }

• deleteFile

  write

  Permanently delete one uploaded file version from a record attachment field.

  Required paramstableIdrecordIdfieldIdversionNumber
  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "recordId": {},
      "fieldId": {},
      "versionNumber": {}
    },
    "additionalProperties": false,
    "required": [
      "tableId",
      "recordId",
      "fieldId",
      "versionNumber"
    ]
  }

• getUsers

  read

  List user accounts belonging to a Quickbase account.

  Input schema

  {
    "type": "object",
    "properties": {
      "accountId": {}
    },
    "additionalProperties": true
  }

• denyUsers

  unknown

  Deny listed users access to the account, revoking their ability to sign in.

  Entitiesuser
  Input schema

  {
    "type": "object",
    "properties": {
      "accountId": {}
    },
    "additionalProperties": true
  }

• denyUsersAndGroups

  unknown

  Deny and remove users from groups

  Required paramsshouldDeleteFromGroups

  Entitiesuser, group
  Input schema

  {
    "type": "object",
    "properties": {
      "shouldDeleteFromGroups": {},
      "accountId": {}
    },
    "additionalProperties": true,
    "required": [
      "shouldDeleteFromGroups"
    ]
  }

• undenyUsers

  unknown

  Undeny users

  Entitiesuser
  Input schema

  {
    "type": "object",
    "properties": {
      "accountId": {}
    },
    "additionalProperties": true
  }

• addMembersToGroup

  write

  Add users as members of an existing group by group id.

  Required paramsgid
  Input schema

  {
    "type": "object",
    "properties": {
      "gid": {}
    },
    "additionalProperties": true,
    "required": [
      "gid"
    ]
  }

• removeMembersFromGroup

  write

  Remove members (Quickbase).

  Required paramsgid
  Input schema

  {
    "type": "object",
    "properties": {
      "gid": {}
    },
    "additionalProperties": false,
    "required": [
      "gid"
    ]
  }

• addManagersToGroup

  write

  Add managers

  Required paramsgid
  Input schema

  {
    "type": "object",
    "properties": {
      "gid": {}
    },
    "additionalProperties": true,
    "required": [
      "gid"
    ]
  }

• removeManagersFromGroup

  write

  Remove managers

  Required paramsgid
  Input schema

  {
    "type": "object",
    "properties": {
      "gid": {}
    },
    "additionalProperties": false,
    "required": [
      "gid"
    ]
  }

• addSubgroupsToGroup

  write

  Add child groups

  Required paramsgid
  Input schema

  {
    "type": "object",
    "properties": {
      "gid": {}
    },
    "additionalProperties": true,
    "required": [
      "gid"
    ]
  }

• removeSubgroupsFromGroup

  write

  Remove child groups

  Required paramsgid
  Input schema

  {
    "type": "object",
    "properties": {
      "gid": {}
    },
    "additionalProperties": false,
    "required": [
      "gid"
    ]
  }

• audit

  unknown

  Get audit logs

  Entitiesaudit log
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• platformAnalyticReads

  unknown

  Get read summaries (Quickbase).

  Entitiesanalytic
  Input schema

  {
    "type": "object",
    "properties": {
      "day": {}
    },
    "additionalProperties": false
  }

• platformAnalyticEventSummaries

  unknown

  Get event summaries

  Entitiesevent
  Input schema

  {
    "type": "object",
    "properties": {
      "accountId": {}
    },
    "additionalProperties": true
  }

• exportSolution

  read

  Export a solution

  Required paramssolutionId
  Input schema

  {
    "type": "object",
    "properties": {
      "solutionId": {}
    },
    "additionalProperties": false,
    "required": [
      "solutionId"
    ]
  }

• updateSolution

  write

  Update a solution

  Required paramssolutionId
  Input schema

  {
    "type": "object",
    "properties": {
      "solutionId": {}
    },
    "additionalProperties": true,
    "required": [
      "solutionId"
    ]
  }

• createSolution

  write

  Create a solution

  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• exportSolutionToRecord

  read

  Export solution to record

  Required paramssolutionId
  Input schema

  {
    "type": "object",
    "properties": {
      "solutionId": {},
      "tableId": {},
      "fieldId": {}
    },
    "additionalProperties": false,
    "required": [
      "solutionId"
    ]
  }

• createSolutionFromRecord

  write

  Create solution from record

  Input schema

  {
    "type": "object",
    "properties": {
      "tableId": {},
      "fieldId": {},
      "recordId": {}
    },
    "additionalProperties": false
  }

• updateSolutionToRecord

  write

  Update solution from record

  Required paramssolutionId
  Input schema

  {
    "type": "object",
    "properties": {
      "solutionId": {},
      "tableId": {},
      "fieldId": {},
      "recordId": {}
    },
    "additionalProperties": false,
    "required": [
      "solutionId"
    ]
  }

• changesetSolution

  unknown

  List solution changes

  Required paramssolutionId

  Entitiessolution change
  Input schema

  {
    "type": "object",
    "properties": {
      "solutionId": {}
    },
    "additionalProperties": true,
    "required": [
      "solutionId"
    ]
  }

• changesetSolutionFromRecord

  unknown

  List solution changes from record

  Required paramssolutionId

  Entitiessolution change
  Input schema

  {
    "type": "object",
    "properties": {
      "solutionId": {},
      "tableId": {},
      "fieldId": {},
      "recordId": {}
    },
    "additionalProperties": false,
    "required": [
      "solutionId"
    ]
  }

• generateDocument

  unknown

  Generate a document

  Required paramstemplateId

  Entitiesdocument
  Input schema

  {
    "type": "object",
    "properties": {
      "templateId": {},
      "tableId": {},
      "recordId": {},
      "filename": {},
      "format": {},
      "margin": {},
      "unit": {},
      "pageSize": {},
      "orientation": {}
    },
    "additionalProperties": false,
    "required": [
      "templateId"
    ]
  }

• getSolutionPublic

  read

  Get solution information

  Required paramssolutionId
  Input schema

  {
    "type": "object",
    "properties": {
      "solutionId": {}
    },
    "additionalProperties": false,
    "required": [
      "solutionId"
    ]
  }

• getTrustees

  read

  Get trustees for an app

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": false,
    "required": [
      "appId"
    ]
  }

• addTrustees

  write

  Add trustees to an app

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": true,
    "required": [
      "appId"
    ]
  }

• removeTrustees

  write

  Remove trustees from an app

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": false,
    "required": [
      "appId"
    ]
  }

• updateTrustees

  write

  Update trustees of an app

  Required paramsappId
  Input schema

  {
    "type": "object",
    "properties": {
      "appId": {}
    },
    "additionalProperties": true,
    "required": [
      "appId"
    ]
  }