Data

The Data module is the foundation of the Enterprise platform. It owns the model registry — the source of truth for every data structure in the system — and automatically exposes CRUD endpoints for all 192+ registered models. It also provides avatar generation, image preview, a generic query API, and real-time change streaming via Server-Sent Events.

What it covers

How auto-CRUD works

Every model registered in the models collection automatically receives six REST endpoints at the path /{moduleKey}/{modelKey}:

GET    /api/{moduleKey}/{modelKey}           list (paginated, filterable)
POST   /api/{moduleKey}/{modelKey}           create
GET    /api/{moduleKey}/{modelKey}/{id}       get by ID
PUT    /api/{moduleKey}/{modelKey}/{id}       full update
PATCH  /api/{moduleKey}/{modelKey}/{id}       partial update
DELETE /api/{moduleKey}/{modelKey}/{id}       delete

For example, the contacts model (owned by the sales module) is served at /api/sales/contacts. The data module itself handles the routing — the owning module only needs to declare the model.

Authentication

All Data endpoints require a valid session.

Core endpoints

Health and status

GET /api/data/health       # returns { status: "ok" }
GET /api/data/datasources  # lists active database connections
GET /api/data/routes/info  # lists all registered CRUD routes

Model registry

GET  /api/data/models              # list all registered models
POST /api/data/models/reload       # hot-reload model definitions from the database

The reload endpoint is useful after adding or modifying model definitions without restarting the server.

Generic query API

Run a structured query across any model:

POST /api/data/query
Content-Type: application/json

{
  "model": "contacts",
  "filter": { "status": "active" },
  "sort": { "createdAt": -1 },
  "page": 1,
  "limit": 50,
  "fields": ["firstName", "lastName", "email", "accountId"]
}

Avatar generation

Generate an AI avatar image for a record (e.g. a contact without a profile photo):

POST /api/data/avatar/generate
{
  "name": "Jane Smith",
  "size": 256
}

Returns a { url: "..." } pointing to the generated image.

Preview images

Generate a preview thumbnail for a stored file:

POST /api/data/preview/generate
{
  "fileId": "<file_id>",
  "width": 400,
  "height": 300
}

Data models (system)

These models are managed by the Data module itself (served at /api/data/{model}):

Database architecture

The Data module connects to two MongoDB databases:

All CRUD routes operate on the tenant (Origin) database. Core data is read-only via the system.

Real-time streaming

The StreamService registers SSE endpoints for live record change events. Connect to receive real-time updates as records are created, updated, or deleted:

GET /api/data/stream?models=contacts,accounts
Accept: text/event-stream

Each SSE event contains the operation type (insert, update, delete) and the affected record.

Projection queries

For complex reporting and aggregated views, projection endpoints are registered per model:

GET  /api/{moduleKey}/{projectionKey}
POST /api/{moduleKey}/{projectionKey}/query
GET  /api/{moduleKey}/{projectionKey}/{id}

Projections are defined in model configuration and can combine data from multiple collections.

API sections

These sections are available in the Data API Reference:

• Avatar
• Data
• Features
• Field Mapping Value Sources
• Field Types
• Icons
• Model Fields
• Model Files
• Model Layouts
• Model Notes
• Model Tasks
• Models
• Navigation Items
• Previewimage
• Query
• Record Files
• Record Notes
• Record Tasks