Documento Convenciones Errores de la API Idempotencia Sesión y acceso (12) Incidentes (20) Resumen (4) Notificaciones (4) Tiempo real (2) Usuarios y roles (16) Auditoría (3) Sistema (10)
GET · 2 POST · 2 Abrir todos GET /notificationsPágina de 20, de la más nueva a la más vieja. meta.unread trae las sin leer de cada pestaña y meta.before, el id para pedir las anteriores (null si no hay más) Cabeceras de la petición Cabecera Valor Para qué AuthorizationBearer trazo_…Token de sesión que entrega el ingreso Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)
Parámetros Nombre Dónde Tipo Obligatorio categoryConsulta "conversations" | "activity" Sí beforeConsulta texto No incidentConsulta texto No
Respuesta 200 Campo Tipo datalista de objeto metaobjeto meta.unreadobjeto meta.beforetexto | null
{
"data": [
"texto"
],
"meta": {
"unread": {},
"before": "texto"
}
}Cabecera de la respuesta Para qué X-Request-IdIdentificador de la petición; es el trace_id de los errores
Errores posibles 401 Sin sesión o la sesión expiró (UNAUTHENTICATED)422 Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API .
Ver el módulo en la biblioteca GET /notifications/unreadSin leer por pestaña: { conversations, activity } Cabeceras de la petición Cabecera Valor Para qué AuthorizationBearer trazo_…Token de sesión que entrega el ingreso Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación)
Respuesta 200 Cabecera de la respuesta Para qué X-Request-IdIdentificador de la petición; es el trace_id de los errores
Errores posibles 401 Sin sesión o la sesión expiró (UNAUTHENTICATED)Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API .
Ver el módulo en la biblioteca POST /notifications/{notification}/readMarca una como leída. Una ajena responde 404 NOTIFICATION_NOT_FOUND. Devuelve las sin leer Cabeceras de la petición Cabecera Valor Para qué AuthorizationBearer trazo_…Token de sesión que entrega el ingreso Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación) X-Socket-IDopcionalPara no recibir en tiempo real el aviso de tu propio cambio
Parámetros Nombre Dónde Tipo Obligatorio notificationRuta texto Sí
Respuesta 200 Cabecera de la respuesta Para qué X-Request-IdIdentificador de la petición; es el trace_id de los errores
Errores posibles 401 Sin sesión o la sesión expiró (UNAUTHENTICATED)404 No existe o quien pregunta no puede verloTodos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API .
Ver el módulo en la biblioteca POST /notifications/readMarca como leídas las de una pestaña (category) y, con incident (ULID), solo las de ese incidente. Devuelve las sin leer Cabeceras de la petición Cabecera Valor Para qué AuthorizationBearer trazo_…Token de sesión que entrega el ingreso Acceptapplication/jsonLa API siempre responde JSON (o un archivo, en la exportación) Content-Typeapplication/jsonCuerpo en JSON X-Socket-IDopcionalPara no recibir en tiempo real el aviso de tu propio cambio
Cuerpo Campo Tipo Obligatorio category"conversations" | "activity" Sí beforetexto No incidenttexto No
{
"category": "conversations",
"before": "texto",
"incident": "01jbzk8m3q9w2e5r7t1y4u6i0p"
}Respuesta 200 Cabecera de la respuesta Para qué X-Request-IdIdentificador de la petición; es el trace_id de los errores
Errores posibles 401 Sin sesión o la sesión expiró (UNAUTHENTICATED)422 Algún dato no es válido (VALIDATION_FAILED, con el detalle por campo)Todos llegan en formato RFC 9457 con su code y trace_id: ver Errores de la API .
Ver el módulo en la biblioteca