CRM v1 solo lectura

`crm.client_overview_get`

Lee cómo está UN cliente dicho por su nombre: sus facturas abiertas con su saldo y desde cuándo se deben, el total adeudado, y por qué canales se ha hablado con el día de su último mensaje. Nunca lo que se dijo, ni teléfono ni correo.

Última actualización22 oct 2026

POST /api/v1/reads/crm.client_overview_get

Alcance del token: crm.client_overview_get@1
Permiso del workspace: api.crm.client_overview_get apagado por defecto
Quién lee: La persona detrás del token, con su rol. Quien deja el workspace deja de leer.

Tres permisos

Un token con ese alcance, que el dueño del workspace haya encendido la lectura, y que el rol de la persona la vea en el producto. Ninguna basta sola. Solo con OAuth →

Petición

campo	tipo		reglas
`client`	string	obligatorio	min 1 · max 200

Respuesta — output cuando status es done

campo	tipo		reglas
`client`	string	obligatorio
`owedTotal`	string	obligatorio	`^-?\d+\.\d{2}$`
`openInvoices`	object[]	obligatorio
`conversations`	object[]	obligatorio
`noActivity`	boolean	obligatorio

openInvoices[]

campo	tipo		reglas
`number`	string \| null	obligatorio
`balance`	string	obligatorio	`^-?\d+\.\d{2}$`
`currency`	string	obligatorio
`dueOn`	string \| null	obligatorio

conversations[]

campo	tipo		reglas
`channel`	string	obligatorio
`lastInboundOn`	string \| null	obligatorio

Ejemplo

# Reads take an OAuth access token, not an API key, and no idempotency key: reading changes nothing.
curl -X POST https://niiko.org/api/v1/reads/crm.client_overview_get \
  -H "Authorization: Bearer $NIIKO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "client": "…"
  }'
# 200 → done · 4xx → refused, with a named reason

Por qué puede negarse

Cada motivo dice quién puede arreglarlo y cómo; detail.message, cuando viene, dice qué hacer. Negativas y códigos HTTP →

invalid_inputrole_forbiddengrant_offreads_need_a_personambiguousnot_found

En los clientes

@vorluno/niiko-sdk	`niiko.getClientOverview()`
niiko (Python)	`niiko.get_client_overview()` desde 0.4.0 · aún no está en el registro
niiko-cli	`niiko read crm.client_overview_get`
n8n-nodes-niiko	Sin lecturas: el nodo lleva una llave, y leer pide una persona por OAuth.
niiko-mcp-server	`crm_client_overview_get` readOnlyHint

Historial

Cinco lecturas más: el catálogo, la base de conocimiento, el saldo y la ficha de un cliente, la configuración del agentePOST /api/v1/reads/{id} contesta cinco lecturas declaradas más: buscar en el catálogo publicado, buscar en la base de conocimiento, cuánto debe un cliente, cómo está un cliente (facturas abiertas y por qué canales se habló, nunca lo que se dijo) y cómo está configurado el agente de ventas. Las mismas reglas que las nueve primeras: solo con OAuth, con el rol de la persona y con un interruptor en el workspace, apagado por defecto. El servidor MCP las lista como herramientas de solo lectura, y @vorluno/niiko-sdk, niiko y niiko-cli 0.4.0 suman un método por cada una.22 oct 2026