Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Quickbase Formulas API
version: 1.0.0
description: 'Operations tagged Formulas across 2 of this provider''s published API definitions: qb-openapi-v3.json, quickbase-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.quickbase.com/v1
tags:
- name: Formulas
paths:
/formula/run:
post:
tags:
- Formulas
summary: Run a formula
description: Allows running a formula via an API call. Use this method in custom code to get the value back of a formula without a discrete field on a record.
operationId: runFormula
parameters:
- $ref: '#/components/parameters/qbRealmHostname'
- $ref: '#/components/parameters/userAgent'
- $ref: '#/components/parameters/authorization'
requestBody:
content:
application/json:
schema:
required:
- formula
- from
type: object
properties:
formula:
type: string
description: The formula to run. This must be a valid Quickbase formula.
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.
from:
$ref: '#/components/schemas/tableId'
description: The following example will execute a Sum() for '20' and the value in a record with id 1 for the field with label 'NumericField'. Since this API is able to run any type of formula, all results will be returned as a string.
example:
from: bck7gp3q2
formula: Sum([NumericField],20)
rid: 1
responses:
'200':
description: Success
content:
application/json:
schema:
example:
result: '30'
type: object
properties:
result:
description: The formula execution result.
type: string
servers:
- url: https://api.quickbase.com/v1
components:
schemas:
tableId:
type: string
pattern: ^(\w+\/\(\w+\)|\w+)$
description: The unique identifier (dbid) of the table.
example: bck7gp3q2
parameters:
authorization:
name: Authorization
in: header
description: The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).
required: true
schema:
type: string
example: QB-USER-TOKEN xxxxxx_xxx_xxxxxxxxxxxxxxxxxxxxxxx
qbRealmHostname:
name: QB-Realm-Hostname
in: header
description: Your Quickbase domain, for example demo.quickbase.com
required: true
schema:
type: string
example: demo.quickbase.com
userAgent:
name: User-Agent
in: header
description: This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
schema:
type: string
example: FileService_Integration_V2.1
x-refined-from:
- qb-openapi-v3.json
- quickbase-openapi.yml