Headless CRM

Clients never memorise this API. They call discover to read the schema and the exact signature of whatever they need, then call execute to run it. Every operation — every create, every report, every bulk write — arrives through the same two entry points.

• No REST surface. The only non-MCP route is GET /health, which returns liveness and exposes no CRM data.
• The catalog is the documentation. Everything on this page is generated from the same registry the server answers discover from, so the two cannot drift apart.
• Errors teach. A wrong field name comes back with the right one; a wrong enum comes back with the allowed values; a wrong operation comes back with the closest matches.

Returns the live catalog: entities, fields, enum values, relations, the query language, and the exact parameter signature of any operation. Call it before guessing a name — it is cheaper than a failed write.

The nine scopes

{
  "scope": "entity",
  "entity": "history"
}

{
  "scope": "search",
  "query": "follow up"
}

Runs any of the 125 operations. operation names the call, params carries its arguments, and four optional modifiers control identity, safety and retries.

{
  "ok": true,
  "operation": "contacts.create",
  "request_id": "req_9f2c1a",
  "took_ms": 3,
  "result": { "record": { "id": "con_…", … } }
}

{
  "ok": false,
  "operation": "contacts.update",
  "error": {
    "code": "unknown_field",
    "message": "contacts: unknown field 'titel'. Did you mean: title?",
    "details": { "entity": "contacts", "field": "titel" }
  },
  "hint": "Call discover({ scope: 'entity', entity: 'contacts' })…"
}

Error codes

Each table gets the same plain CRUD; the contact, company, report, email and meta calls sit on top. Names in teal only read; names in vermilion can write. Open a row for its signature.

• Per table — list get create update delete restore count aggregate describe, plus upsert on contacts and companies.
• In bulk — bulk_get bulk_create bulk_update bulk_delete bulk_restore on every table, and bulk.execute to run several different operations in one atomic round trip.
• contact.* is where the work happens: profile for the whole customer in one call, log to record what happened, history to page back through it, find, set_stage, due, complete_follow_up, merge.
• Reports answer the questions a small team actually asks — what is in the pipeline, how much is happening, who has gone quiet, who is carrying what.

A contact is the key record; history is everything that ever happened with them, one row per event. companies is where they work and users is who on your side is dealing with them. Everything belongs to an organisation, and nothing is visible across that boundary. Every row carries id, created_at, updated_at, created_by, updated_by, deleted_at and version. Ids are prefixed per table, so an id always announces its own type.

The same vocabulary works on list, count, aggregate, bulk_update and bulk_delete. Values are coerced to the field's type and enums are validated, so a typo fails loudly rather than matching nothing.

{
  "stage": "proposal",                      // equality
  "value": { "gte": 10000, "lt": 250000 },   // operators
  "owner_id": ["usr_a", "usr_b"],           // list = IN
  "next_step_date": { "between": ["2026-09-01", "2026-09-30"] },
  "$or": [
    { "source": "referral" },
    { "value": { "gte": 100000 } }
  ]
}

{
  "operation": "contacts.list",
  "params": {
    "filters": { "stage": "proposal", "value": { "gte": 10000 } },
    "sort": "-value",
    "fields": ["full_name", "value", "next_step_date"],
    "include": ["company_id"],
    "limit": 25
  }
}

{
  "operation": "contacts.aggregate",
  "params": {
    "group_by": ["stage"],
    "metrics": [
      { "fn": "sum", "field": "value", "as": "pipeline" },
      { "fn": "count", "field": "id", "as": "contacts" }
    ],
    "sort": "-pipeline"
  }
}

The same twelve calls discover({ scope: "examples" }) returns, ready to paste into execute.

Enum fields accept these values, case-insensitively, and store the canonical spelling. A rejected value comes back with the full list attached.