KosmoKrator

data

QuickBase CLI for AI Agents

Use the QuickBase CLI from KosmoKrator to call QuickBase tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

QuickBase CLI Setup

QuickBase can be configured headlessly with `kosmokrator integrations:configure quickbase`.

Install, configure, and verify
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure quickbase --set access_token="$QUICKBASE_ACCESS_TOKEN" --set realm_hostname="$QUICKBASE_REALM_HOSTNAME" --enable --read allow --write ask --json
kosmokrator integrations:doctor quickbase --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
access_token QUICKBASE_ACCESS_TOKEN Secret secret yes Access Token
realm_hostname QUICKBASE_REALM_HOSTNAME Text text yes Realm Hostname
base_url QUICKBASE_BASE_URL URL url no API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call
kosmo integrations:call quickbase.quickbase_list_apps '{"params":"example_params"}' --json
Provider shortcut
kosmo integrations:quickbase quickbase_list_apps '{"params":"example_params"}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands
kosmo integrations:docs quickbase --json
kosmo integrations:docs quickbase.quickbase_list_apps --json
kosmo integrations:schema quickbase.quickbase_list_apps --json
kosmo integrations:search "QuickBase" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

quickbase.quickbase_list_apps

List Quickbase apps available to the authenticated user.

Read read
Parameters
params
Generic call
kosmo integrations:call quickbase.quickbase_list_apps '{"params":"example_params"}' --json
Shortcut
kosmo integrations:quickbase quickbase_list_apps '{"params":"example_params"}' --json

quickbase.quickbase_get_app

Get metadata for a Quickbase app.

Read read
Parameters
appId
Generic call
kosmo integrations:call quickbase.quickbase_get_app '{"appId":"example_appId"}' --json
Shortcut
kosmo integrations:quickbase quickbase_get_app '{"appId":"example_appId"}' --json

quickbase.quickbase_create_app

Create a Quickbase app.

Write write
Parameters
body
Generic call
kosmo integrations:call quickbase.quickbase_create_app '{"body":"example_body"}' --json
Shortcut
kosmo integrations:quickbase quickbase_create_app '{"body":"example_body"}' --json

quickbase.quickbase_copy_app

Copy an existing Quickbase app.

Write write
Parameters
appId, body
Generic call
kosmo integrations:call quickbase.quickbase_copy_app '{"appId":"example_appId","body":"example_body"}' --json
Shortcut
kosmo integrations:quickbase quickbase_copy_app '{"appId":"example_appId","body":"example_body"}' --json

quickbase.quickbase_delete_app

Delete a Quickbase app by ID.

Write write
Parameters
appId, name
Generic call
kosmo integrations:call quickbase.quickbase_delete_app '{"appId":"example_appId","name":"example_name"}' --json
Shortcut
kosmo integrations:quickbase quickbase_delete_app '{"appId":"example_appId","name":"example_name"}' --json

quickbase.quickbase_list_tables

List all tables in a QuickBase application. Returns table IDs, names, and metadata for each table in the specified app.

Read read
Parameters
appId
Generic call
kosmo integrations:call quickbase.quickbase_list_tables '{"appId":"example_appId"}' --json
Shortcut
kosmo integrations:quickbase quickbase_list_tables '{"appId":"example_appId"}' --json

quickbase.quickbase_get_table

Get details for a specific QuickBase table, including its name, ID, and field definitions.

Read read
Parameters
tableId
Generic call
kosmo integrations:call quickbase.quickbase_get_table '{"tableId":"example_tableId"}' --json
Shortcut
kosmo integrations:quickbase quickbase_get_table '{"tableId":"example_tableId"}' --json

quickbase.quickbase_create_table

Create a table in a Quickbase app.

Write write
Parameters
appId, body
Generic call
kosmo integrations:call quickbase.quickbase_create_table '{"appId":"example_appId","body":"example_body"}' --json
Shortcut
kosmo integrations:quickbase quickbase_create_table '{"appId":"example_appId","body":"example_body"}' --json

quickbase.quickbase_update_table

Update Quickbase table metadata.

Write write
Parameters
tableId, body
Generic call
kosmo integrations:call quickbase.quickbase_update_table '{"tableId":"example_tableId","body":"example_body"}' --json
Shortcut
kosmo integrations:quickbase quickbase_update_table '{"tableId":"example_tableId","body":"example_body"}' --json

quickbase.quickbase_delete_table

Delete a Quickbase table.

Write write
Parameters
tableId
Generic call
kosmo integrations:call quickbase.quickbase_delete_table '{"tableId":"example_tableId"}' --json
Shortcut
kosmo integrations:quickbase quickbase_delete_table '{"tableId":"example_tableId"}' --json

quickbase.quickbase_list_fields

List field definitions in a Quickbase table.

Read read
Parameters
tableId, params
Generic call
kosmo integrations:call quickbase.quickbase_list_fields '{"tableId":"example_tableId","params":"example_params"}' --json
Shortcut
kosmo integrations:quickbase quickbase_list_fields '{"tableId":"example_tableId","params":"example_params"}' --json

quickbase.quickbase_get_field

Get a Quickbase field definition by field ID.

Read read
Parameters
tableId, fieldId
Generic call
kosmo integrations:call quickbase.quickbase_get_field '{"tableId":"example_tableId","fieldId":1}' --json
Shortcut
kosmo integrations:quickbase quickbase_get_field '{"tableId":"example_tableId","fieldId":1}' --json

quickbase.quickbase_create_field

Create a field in a Quickbase table.

Write write
Parameters
tableId, body
Generic call
kosmo integrations:call quickbase.quickbase_create_field '{"tableId":"example_tableId","body":"example_body"}' --json
Shortcut
kosmo integrations:quickbase quickbase_create_field '{"tableId":"example_tableId","body":"example_body"}' --json

quickbase.quickbase_update_field

Update field properties in a Quickbase table.

Write write
Parameters
tableId, fieldId, body
Generic call
kosmo integrations:call quickbase.quickbase_update_field '{"tableId":"example_tableId","fieldId":1,"body":"example_body"}' --json
Shortcut
kosmo integrations:quickbase quickbase_update_field '{"tableId":"example_tableId","fieldId":1,"body":"example_body"}' --json

quickbase.quickbase_delete_field

Delete a field from a Quickbase table.

Write write
Parameters
tableId, fieldId
Generic call
kosmo integrations:call quickbase.quickbase_delete_field '{"tableId":"example_tableId","fieldId":1}' --json
Shortcut
kosmo integrations:quickbase quickbase_delete_field '{"tableId":"example_tableId","fieldId":1}' --json

quickbase.quickbase_list_records

Query records from a QuickBase table. Supports filtering by conditions, selecting specific fields, sorting, grouping, and pagination. Use the where clause to filter records (QuickBase query syntax).

Read read
Parameters
tableId, where, select, sortBy, groupBy, options
Generic call
kosmo integrations:call quickbase.quickbase_list_records '{"tableId":"example_tableId","where":"example_where","select":"example_select","sortBy":"example_sortBy","groupBy":"example_groupBy","options":"example_options"}' --json
Shortcut
kosmo integrations:quickbase quickbase_list_records '{"tableId":"example_tableId","where":"example_where","select":"example_select","sortBy":"example_sortBy","groupBy":"example_groupBy","options":"example_options"}' --json

quickbase.quickbase_get_record

Get a single QuickBase record by its record ID. Returns all field values for the specified record.

Read read
Parameters
tableId, recordId
Generic call
kosmo integrations:call quickbase.quickbase_get_record '{"tableId":"example_tableId","recordId":1}' --json
Shortcut
kosmo integrations:quickbase quickbase_get_record '{"tableId":"example_tableId","recordId":1}' --json

quickbase.quickbase_create_record

Create a new record in a QuickBase table. Provide field data as an array of {fieldId, value} pairs.

Write write
Parameters
tableId, fields
Generic call
kosmo integrations:call quickbase.quickbase_create_record '{"tableId":"example_tableId","fields":"example_fields"}' --json
Shortcut
kosmo integrations:quickbase quickbase_create_record '{"tableId":"example_tableId","fields":"example_fields"}' --json

quickbase.quickbase_upsert_records

Upsert one or more Quickbase records, optionally using a merge field.

Write write
Parameters
tableId, data, mergeFieldId, fieldsToReturn
Generic call
kosmo integrations:call quickbase.quickbase_upsert_records '{"tableId":"example_tableId","data":"example_data","mergeFieldId":1,"fieldsToReturn":"example_fieldsToReturn"}' --json
Shortcut
kosmo integrations:quickbase quickbase_upsert_records '{"tableId":"example_tableId","data":"example_data","mergeFieldId":1,"fieldsToReturn":"example_fieldsToReturn"}' --json

quickbase.quickbase_delete_records

Delete Quickbase records matching a where clause.

Write write
Parameters
tableId, where
Generic call
kosmo integrations:call quickbase.quickbase_delete_records '{"tableId":"example_tableId","where":"example_where"}' --json
Shortcut
kosmo integrations:quickbase quickbase_delete_records '{"tableId":"example_tableId","where":"example_where"}' --json

quickbase.quickbase_list_reports

List reports for a Quickbase table.

Read read
Parameters
tableId
Generic call
kosmo integrations:call quickbase.quickbase_list_reports '{"tableId":"example_tableId"}' --json
Shortcut
kosmo integrations:quickbase quickbase_list_reports '{"tableId":"example_tableId"}' --json

quickbase.quickbase_get_report

Get metadata for a Quickbase report.

Read read
Parameters
tableId, reportId
Generic call
kosmo integrations:call quickbase.quickbase_get_report '{"tableId":"example_tableId","reportId":"example_reportId"}' --json
Shortcut
kosmo integrations:quickbase quickbase_get_report '{"tableId":"example_tableId","reportId":"example_reportId"}' --json

quickbase.quickbase_run_report

Run a Quickbase report and return its data.

Read read
Parameters
tableId, reportId, body
Generic call
kosmo integrations:call quickbase.quickbase_run_report '{"tableId":"example_tableId","reportId":"example_reportId","body":"example_body"}' --json
Shortcut
kosmo integrations:quickbase quickbase_run_report '{"tableId":"example_tableId","reportId":"example_reportId","body":"example_body"}' --json

quickbase.quickbase_list_relationships

List relationships for a Quickbase table.

Read read
Parameters
tableId
Generic call
kosmo integrations:call quickbase.quickbase_list_relationships '{"tableId":"example_tableId"}' --json
Shortcut
kosmo integrations:quickbase quickbase_list_relationships '{"tableId":"example_tableId"}' --json

quickbase.quickbase_create_relationship

Create a relationship for a Quickbase table.

Write write
Parameters
tableId, body
Generic call
kosmo integrations:call quickbase.quickbase_create_relationship '{"tableId":"example_tableId","body":"example_body"}' --json
Shortcut
kosmo integrations:quickbase quickbase_create_relationship '{"tableId":"example_tableId","body":"example_body"}' --json

quickbase.quickbase_delete_relationship

Delete a Quickbase table relationship.

Write write
Parameters
tableId, relationshipId
Generic call
kosmo integrations:call quickbase.quickbase_delete_relationship '{"tableId":"example_tableId","relationshipId":1}' --json
Shortcut
kosmo integrations:quickbase quickbase_delete_relationship '{"tableId":"example_tableId","relationshipId":1}' --json

quickbase.quickbase_get_current_user

Get the currently authenticated QuickBase user. Returns user profile information including name, email, and user ID.

Read read
Parameters
none
Generic call
kosmo integrations:call quickbase.quickbase_get_current_user '{}' --json
Shortcut
kosmo integrations:quickbase quickbase_get_current_user '{}' --json

quickbase.quickbase_api_get

Call a documented Quickbase REST API GET endpoint.

Read read
Parameters
path, params
Generic call
kosmo integrations:call quickbase.quickbase_api_get '{"path":"example_path","params":"example_params"}' --json
Shortcut
kosmo integrations:quickbase quickbase_api_get '{"path":"example_path","params":"example_params"}' --json

quickbase.quickbase_api_post

Call a documented Quickbase REST API POST endpoint.

Write write
Parameters
path, body, query
Generic call
kosmo integrations:call quickbase.quickbase_api_post '{"path":"example_path","body":"example_body","query":"example_query"}' --json
Shortcut
kosmo integrations:quickbase quickbase_api_post '{"path":"example_path","body":"example_body","query":"example_query"}' --json

quickbase.quickbase_api_delete

Call a documented Quickbase REST API DELETE endpoint.

Write write
Parameters
path, body, query
Generic call
kosmo integrations:call quickbase.quickbase_api_delete '{"path":"example_path","body":"example_body","query":"example_query"}' --json
Shortcut
kosmo integrations:quickbase quickbase_api_delete '{"path":"example_path","body":"example_body","query":"example_query"}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

quickbase.quickbase_list_apps 1 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_list_apps --json
ParameterTypeRequiredDescription
params object no Optional query parameters such as name, limit, and offset.
quickbase.quickbase_get_app 1 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_get_app --json
ParameterTypeRequiredDescription
appId string yes The application ID.
quickbase.quickbase_create_app 1 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_create_app --json
ParameterTypeRequiredDescription
body object yes App creation payload.
quickbase.quickbase_copy_app 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_copy_app --json
ParameterTypeRequiredDescription
appId string yes The source application ID.
body object no Optional copy settings.
quickbase.quickbase_delete_app 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_delete_app --json
ParameterTypeRequiredDescription
appId string yes The application ID.
name string no Optional app name confirmation.
quickbase.quickbase_list_tables 1 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_list_tables --json
ParameterTypeRequiredDescription
appId string yes The application ID (dbid) to list tables for.
quickbase.quickbase_get_table 1 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_get_table --json
ParameterTypeRequiredDescription
tableId string yes The table ID (dbid) to retrieve details for.
quickbase.quickbase_create_table 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_create_table --json
ParameterTypeRequiredDescription
appId string yes The application ID.
body object yes Table creation payload.
quickbase.quickbase_update_table 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_update_table --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
body object yes Table attributes to update.
quickbase.quickbase_delete_table 1 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_delete_table --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
quickbase.quickbase_list_fields 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_list_fields --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
params object no Optional query parameters such as includeFieldPerms.
quickbase.quickbase_get_field 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_get_field --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
fieldId integer yes The field ID.
quickbase.quickbase_create_field 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_create_field --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
body object yes Field creation payload.
quickbase.quickbase_update_field 3 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_update_field --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
fieldId integer yes The field ID.
body object yes Field attributes to update.
quickbase.quickbase_delete_field 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_delete_field --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
fieldId integer yes The field ID.
quickbase.quickbase_list_records 6 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_list_records --json
ParameterTypeRequiredDescription
tableId string yes The table ID (dbid) to query records from.
where string no Filter expression in QuickBase query syntax, e.g. '{3.EX.'Complete'}'. Omit to return all records.
select array no Array of field IDs to include in the response. Omit to return all fields.
sortBy array no Sort specification: [{fieldId: 3, order: "ASC"}, ...].
groupBy array no Grouping specification: [{fieldId: 3, grouping: "equal-values"}, ...].
options object no Additional query options: {skip: 0, top: 100, compareWith: "yesterday", includeRids: true}.
quickbase.quickbase_get_record 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_get_record --json
ParameterTypeRequiredDescription
tableId string yes The table ID (dbid) the record belongs to.
recordId integer yes The record ID to retrieve.
quickbase.quickbase_create_record 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_create_record --json
ParameterTypeRequiredDescription
tableId string yes The table ID (dbid) to create the record in.
fields array yes Array of field data objects: [{fieldId: 6, value: "New value"}, {fieldId: 7, value: 42}, ...]. Each object must have a fieldId (integer) and value (mixed).
quickbase.quickbase_upsert_records 4 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_upsert_records --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
data array yes Record data array using Quickbase field ID objects.
mergeFieldId integer no Optional merge field ID.
fieldsToReturn array no Optional field IDs to return.
quickbase.quickbase_delete_records 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_delete_records --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
where string yes Quickbase query expression selecting records to delete.
quickbase.quickbase_list_reports 1 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_list_reports --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
quickbase.quickbase_get_report 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_get_report --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
reportId string yes The report ID.
quickbase.quickbase_run_report 3 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_run_report --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
reportId string yes The report ID.
body object no Optional report run options.
quickbase.quickbase_list_relationships 1 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_list_relationships --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
quickbase.quickbase_create_relationship 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_create_relationship --json
ParameterTypeRequiredDescription
tableId string yes The parent table ID.
body object yes Relationship creation payload.
quickbase.quickbase_delete_relationship 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_delete_relationship --json
ParameterTypeRequiredDescription
tableId string yes The table ID.
relationshipId integer yes The relationship ID.
quickbase.quickbase_get_current_user 0 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_get_current_user --json
ParameterTypeRequiredDescription
No parameters.
quickbase.quickbase_api_get 2 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_api_get --json
ParameterTypeRequiredDescription
path string yes Endpoint path, such as /apps or /fields.
params object no Optional query parameters.
quickbase.quickbase_api_post 3 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_api_post --json
ParameterTypeRequiredDescription
path string yes Endpoint path, such as /records.
body object no JSON request body.
query object no Optional query parameters.
quickbase.quickbase_api_delete 3 parameters
Schema command
kosmo integrations:schema quickbase.quickbase_api_delete --json
ParameterTypeRequiredDescription
path string yes Endpoint path, such as /records.
body object no JSON request body.
query object no Optional query parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.