App DB API

AppDB is Domo’s built-in NoSQL document store. It lets apps persist and query arbitrary JSON documents without requiring an external database. Data is organized in three layers: a Datastore contains one or more Collections, and each Collection holds Documents.

Data Model

Layer	SQL analogy	Description
Datastore	Database	The top-level namespace. Typically one datastore per app. Identified by a UUID id — not the numeric datastore_id that also appears in responses.
Collection	Table	A typed bucket of documents. A collection’s schema describes the fields in each document’s content object — primarily used to sync documents into a Domo DataSet.
Document	Row	A JSON object with a system-managed envelope (id, owner, createdOn, etc.) and a free-form content object that holds your app data.

API Surfaces

Product API

The Product API is the full management surface for AppDB. Authenticate with a Domo developer token:

X-DOMO-Developer-Token: <your developer token>

Base path: /api/datastores/

The Product API supports the complete lifecycle — create, read, update, and delete datastores and collections; manage permissions; write and query documents; and transfer data in bulk.

App Framework API

If you’re building a Domo Custom App, a scoped proxy is available at /domo/datastores/ that uses the card’s session rather than a developer token. It covers collection and document CRUD and export, but does not expose datastore management, permission reads, download, or import — those remain Product API-only.

See the App Framework AppDB API for the full reference.

Quick Start

The following example creates a datastore, adds a collection, stores a document, and reads it back. Requires curl and jq.

Set your credentials

You’ll need a Domo developer token — see Manage Access Tokens for instructions on generating one.

TOKEN="your-developer-token"
INSTANCE="https://yourcompany.domo.com"

1. Create a datastore

DS_ID=$(curl --silent --request POST "$INSTANCE/api/datastores/v1" \
  --header "X-DOMO-Developer-Token: $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"name":"my-app"}' | jq -r '.id')
echo "Datastore ID: $DS_ID"

2. Create a collection

COL_ID=$(curl --silent --request POST "$INSTANCE/api/datastores/v1/collections?datastoreId=$DS_ID" \
  --header "X-DOMO-Developer-Token: $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "preferences",
    "syncEnabled": false,
    "schema": {
      "columns": [
        {"type": "STRING", "name": "theme"},
        {"type": "STRING", "name": "defaultView"}
      ]
    }
  }' | jq -r '.id')
echo "Collection ID: $COL_ID"

3. Create a document

curl --silent --request POST "$INSTANCE/api/datastores/v1/collections/$COL_ID/documents" \
  --header "X-DOMO-Developer-Token: $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"content":{"userId":"1042","theme":"dark","defaultView":"chart"}}' | jq

4. Query documents

curl --silent --request POST "$INSTANCE/api/datastores/v2/collections/$COL_ID/documents/query" \
  --header "X-DOMO-Developer-Token: $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"content.theme":{"$eq":"dark"}}' | jq

Endpoint Reference

Use the sidebar to browse all endpoints, or jump to a starting point below.

Datastores

List Datastores

Create Datastore

Get Datastore

Delete Datastore

Sync Datastore

Collections

List Collections

Create Collection

Query Collections

Get Collection

Update Collection

Delete Collection

List Permissions

Check User Permission

Update Permissions

Documents

List Documents

Create Document

Get Document

Replace Document

Delete Document

Bulk Create

Bulk Upsert

Bulk Delete

Query Documents

Partially Update Documents

Download Documents

Import Documents