niiko/developers

Ciita · agenda v1 solo lectura

ciita.agenda_get

Lee las citas de hoy, esta semana, la próxima o este mes: cuántas por estado y las 15 primeras con día, hora en la zona de la empresa, cliente, recurso y estado. No agenda nada.

Última actualización

POST /api/v1/reads/ciita.agenda_get
Alcance del token
ciita.agenda_get@1
Permiso del workspace
api.ciita.agenda_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

campotiporeglas
period"today" | "this_week" | "next_week" | "this_month"opcional

Respuesta — output cuando status es done

campotiporeglas
period"today" | "this_week" | "next_week" | "this_month"obligatorio
todaystringobligatorio^\d{4}-\d{2}-\d{2}$
periodStartstringobligatorio^\d{4}-\d{2}-\d{2}$
periodEndstringobligatorio^\d{4}-\d{2}-\d{2}$
timeZonestringobligatorio
appointmentsintegerobligatorio≥ 0
byStatusmap<string, unknown>obligatorio
totalIsMinimumbooleanobligatorio
firstobject[]obligatorio

first[]

campotiporeglas
datestringobligatorio^\d{4}-\d{2}-\d{2}$
timestringobligatorio^\d{2}:\d{2}$
clientstring | nullobligatorio
resourcestring | nullobligatorio
statusstringobligatorio

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/ciita.agenda_get \
  -H "Authorization: Bearer $NIIKO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
# 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_person

En los clientes

@vorluno/niiko-sdkniiko.getAgenda()
niiko (Python)niiko.get_agenda() desde 0.3.0 · aún no está en el registro
niiko-cliniiko read ciita.agenda_get
n8n-nodes-niikoSin lecturas: el nodo lleva una llave, y leer pide una persona por OAuth.
niiko-mcp-serverciita_agenda_get readOnlyHint

Historial