{ "components": { "securitySchemes": { "bearerAuth": { "bearerFormat": "nxl_live_…", "description": "Developer API key from Settings → Developer API.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Nexulex developer API. Authenticate every request with a developer API key (Settings → Developer API) sent as `Authorization: Bearer nxl_live_…`. Action routes are POST with a `{\"args\": [...]}` body and answer with the action's JSON payload.", "title": "Nexulex API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/api/actions/activity/mutations/mark-activity-read": { "post": { "description": "Mark activity read\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-activity-mutations-mark-activity-read", "requestBody": { "content": { "application/json": { "example": { "args": [ { "eventId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "eventId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "eventId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "eventId": { "type": "string" } }, "required": [ "eventId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark activity read", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/activity/queries/get-activity-events": { "post": { "description": "Get activity events\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-activity-queries-get-activity-events", "requestBody": { "content": { "application/json": { "example": { "args": [ { "eventType": "", "limit": 0, "unreadOnly": false } ] }, "schema": { "properties": { "args": { "items": { "properties": { "eventType": { "type": "string" }, "limit": { "type": "number" }, "unreadOnly": { "type": "boolean" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "events": [ { "id": "string", "eventType": "string", "targetKind": "string", "targetId": "string", "caseType": "string", "caseId": "string", "title": "string", "preview": "string", "occurredAt": "2026-01-31T12:00:00Z", "actorId": "string", "read": true } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "events": { "description": "Events, newest first.", "items": { "properties": { "actorId": { "description": "Id of the user who performed the action.", "type": [ "string", "null" ] }, "caseId": { "description": "Case id; see `caseType` for which kind.", "type": [ "string", "null" ] }, "caseType": { "description": "`TRACKED` for a PJUD causa, `INTERNAL` for an expediente.", "type": [ "string", "null" ] }, "eventType": { "description": "Event type.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "occurredAt": { "description": "When it happened (ISO 8601).", "format": "date-time", "type": "string" }, "preview": { "description": "Short preview of the content.", "type": [ "string", "null" ] }, "read": { "description": "Whether the API key's acting user has read it.", "type": "boolean" }, "targetId": { "description": "Id of the record the event is about.", "type": "string" }, "targetKind": { "description": "Kind of record the event is about.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "eventType", "targetKind", "targetId", "caseType", "caseId", "title", "preview", "occurredAt", "actorId", "read" ], "type": "object" }, "type": "array" } }, "required": [ "events" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get activity events", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/agenda/events/delete-agenda-event": { "post": { "description": "Delete agenda event\n\nAuthentication: developer API key. Required scope: `agenda:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-agenda-events-delete-agenda-event", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"agenda:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"agenda:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "agenda:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete agenda event", "tags": [ "Agenda" ], "x-modifies-data": true, "x-required-scope": "agenda:write" } }, "/api/actions/agenda/events/list-agenda": { "post": { "description": "List agenda\n\nAuthentication: developer API key. Required scope: `agenda:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-agenda-events-list-agenda", "requestBody": { "content": { "application/json": { "example": { "args": [ { "from": "", "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "id": "string", "source": "string", "kind": "string", "title": "string", "startsAt": "2026-01-31T12:00:00Z", "endsAt": "2026-01-31T12:00:00Z", "location": "string", "videoUrl": "string", "notes": "string", "causaId": "string", "internalCauseId": "string", "rol": "string", "caratulado": "string", "expediente": "string", "invitees": "string" } ], "from": "2026-01-31T12:00:00Z", "to": "2026-01-31T12:00:00Z" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "from": { "description": "Start of the range (ISO 8601).", "format": "date-time", "type": "string" }, "items": { "description": "The records returned.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "endsAt": { "format": "date-time", "type": [ "string", "null" ] }, "expediente": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "internalCauseId": { "description": "Expediente (internal case) id.", "type": "string" }, "invitees": { "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "location": { "type": "string" }, "notes": { "description": "Free-text notes.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "source": { "description": "Where the record came from.", "type": "string" }, "startsAt": { "format": "date-time", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "videoUrl": { "type": "string" } }, "required": [ "id", "source", "kind", "title", "startsAt", "endsAt", "location", "videoUrl", "notes", "causaId", "internalCauseId", "rol", "caratulado", "expediente", "invitees" ], "type": "object" }, "type": "array" }, "to": { "description": "End of the range (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "items", "from", "to" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"agenda:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"agenda:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "agenda:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List agenda", "tags": [ "Agenda" ], "x-required-scope": "agenda:read" } }, "/api/actions/agenda/events/save-agenda-event": { "post": { "description": "Save agenda event\n\nAuthentication: developer API key. Required scope: `agenda:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-agenda-events-save-agenda-event", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "clientIds": [], "emails": [], "endsAt": "", "id": "", "internalCauseId": "", "kind": "", "location": "", "notes": "", "notifyInvitees": false, "startsAt": "", "title": "", "userIds": [], "videoUrl": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "clientIds": { "items": { "type": "string" }, "type": "array" }, "emails": { "items": { "type": "string" }, "type": "array" }, "endsAt": { "type": "string" }, "id": { "type": "string" }, "internalCauseId": { "type": "string" }, "kind": { "type": "string" }, "location": { "type": "string" }, "notes": { "type": "string" }, "notifyInvitees": { "type": "boolean" }, "startsAt": { "type": "string" }, "title": { "type": "string" }, "userIds": { "items": { "type": "string" }, "type": "array" }, "videoUrl": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"agenda:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"agenda:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "agenda:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save agenda event", "tags": [ "Agenda" ], "x-modifies-data": true, "x-required-scope": "agenda:write" } }, "/api/actions/assistant/conversations/delete-assistant-conversation": { "post": { "description": "Delete assistant conversation\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-assistant-conversations-delete-assistant-conversation", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete assistant conversation", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/actions/assistant/conversations/get-assistant-conversation": { "post": { "description": "Get assistant conversation\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-assistant-conversations-get-assistant-conversation", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversation": { "id": "string", "title": "string", "caseId": "string", "caseKind": "string", "caseLabel": "string", "mode": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" }, "messages": [ { "id": "string", "role": "string", "content": "string", "sources": [ { "kind": "string", "ref": "string", "title": "string", "url": "string", "snippet": "string", "score": 0 } ], "warnings": [ "string" ], "caseLabel": "string", "createdAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversation": { "properties": { "caseId": { "description": "Case id; see `caseType` for which kind.", "type": "string" }, "caseKind": { "type": "string" }, "caseLabel": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "mode": { "description": "Mode.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "caseId", "caseKind", "caseLabel", "mode", "createdAt", "updatedAt" ], "type": "object" }, "messages": { "description": "Chat messages, oldest first.", "items": { "properties": { "caseLabel": { "type": "string" }, "content": { "description": "Content.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "role": { "description": "Role.", "type": "string" }, "sources": { "items": { "properties": { "kind": { "description": "Record subtype.", "type": "string" }, "ref": { "type": "string" }, "score": { "type": "number" }, "snippet": { "type": "string" }, "title": { "description": "Title.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "kind", "ref", "title", "snippet", "score" ], "type": "object" }, "type": "array" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "role", "content", "sources", "warnings", "caseLabel", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "conversation", "messages" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get assistant conversation", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/actions/assistant/conversations/list-assistant-conversations": { "post": { "description": "List assistant conversations\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-assistant-conversations-list-assistant-conversations", "requestBody": { "content": { "application/json": { "example": { "args": [ { "limit": 0, "offset": 0, "q": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "q": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversations": [ { "id": "string", "title": "string", "caseId": "string", "caseKind": "string", "caseLabel": "string", "mode": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversations": { "items": { "properties": { "caseId": { "description": "Case id; see `caseType` for which kind.", "type": "string" }, "caseKind": { "type": "string" }, "caseLabel": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "mode": { "description": "Mode.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "caseId", "caseKind", "caseLabel", "mode", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "conversations" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List assistant conversations", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/actions/assistant/conversations/rename-assistant-conversation": { "post": { "description": "Rename assistant conversation\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-assistant-conversations-rename-assistant-conversation", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "title": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Rename assistant conversation", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/actions/assistant/documents/export-assistant-message": { "post": { "description": "Export assistant message\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-assistant-documents-export-assistant-message", "requestBody": { "content": { "application/json": { "example": { "args": [ { "format": "", "messageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "format": { "type": "string" }, "messageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "name": "string", "mime": "string", "contentBase64": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "contentBase64": { "type": "string" }, "mime": { "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "name", "mime", "contentBase64" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Export assistant message", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/actions/assistant/templates/list-assistant-templates": { "post": { "description": "List assistant templates\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-assistant-templates-list-assistant-templates", "requestBody": { "content": { "application/json": { "example": { "args": [ {} ] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "templates": [ { "id": "string", "kind": "string", "name": "string", "description": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "templates": { "items": { "properties": { "description": { "description": "Free-text description.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "kind", "name" ], "type": "object" }, "type": "array" } }, "required": [ "templates" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List assistant templates", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/actions/billing/queries/get-client-billing-workspace-data": { "post": { "description": "Get client billing workspace data\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-billing-queries-get-client-billing-workspace-data", "requestBody": { "content": { "application/json": { "example": { "args": [ {} ] }, "schema": { "properties": { "args": { "items": { "description": "scopeArg", "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "errorEn": "string", "data": { "organizationIds": [ "string" ], "resolvedOrganizationId": "string", "organizations": [ { "id": "string", "name": "string", "subscription": "string", "commercialPlan": "string", "connectedCauseCap": 0, "extraCausaClp": 0, "apiIncludedRequestsPerCause": 0, "activeConnectedCauses": 0, "billableConnectedCauses": 0, "includedApiRequests": 0, "apiBillableUnitsCurrentMonth": 0, "apiOverageUnitsCurrentMonth": 0, "billingWarning": "string", "hasFinancialProfile": true, "provider": "string", "openInvoices": 0, "overdueInvoices": 0, "nextDueDate": "string", "financialProfile": { "companyName": "string", "rut": "string", "country": "string", "comuna": "string", "address": "string", "giro": "string", "dteEmail": "string", "cardCount": 0, "provider": "string" }, "activeCoupons": [ { "kind": "string", "description": "string", "descriptionEn": "string", "remaining": "string", "remainingEn": "string", "id": "string", "code": "string", "active": true, "valid": true, "quantityLeft": 0, "validFrom": "string", "validUntil": "string", "amount": "string", "discount": 0, "historyCreatedAt": "string", "eliminatedAt": "string" } ], "couponHistory": [ { "kind": "string", "description": "string", "descriptionEn": "string", "remaining": "string", "remainingEn": "string", "id": "string", "code": "string", "active": true, "valid": true, "quantityLeft": 0, "validFrom": "string", "validUntil": "string", "amount": "string", "discount": 0, "historyCreatedAt": "string", "eliminatedAt": "string" } ], "serviceUsage": null, "watchedRuts": 0, "rutMonitorFreeRuts": 0, "rutMonitorExtraRuts": 0, "rutMonitorPriceInclusive": 0, "rutMonitorEstimatedInclusive": 0 } ], "invoices": [ { "id": "string", "orgId": "string", "orgName": "string", "invoiceNumber": 0, "status": "string", "subscription": "string", "commercialPlan": "string", "total": 0, "dueDate": "string", "paidAt": "string", "paymentStatus": "string", "paymentStatusDetail": "string", "invoicePdfUrl": "string", "tryNumber": 0, "billableConnectedCauseCount": 0, "actualConnectedCauseCount": 0, "connectedCauseCap": 0, "includedApiRequests": 0, "apiBillableUnits": 0, "apiOverageUnits": 0, "apiOverageSubtotal": 0, "watchedRuts": 0, "rutMonitorFreeRuts": 0, "rutMonitorBillableRuts": 0, "rutMonitorSubtotal": 0, "billingWarning": "string", "lines": [ { "key": "string", "label": "string", "quantity": "string", "unitAmount": 0, "subtotal": 0 } ], "mpPaymentId": "string" } ], "upcomingInvoices": [ { "id": "string", "orgId": "string", "orgName": "string", "invoiceNumber": 0, "status": "string", "subscription": "string", "commercialPlan": "string", "total": 0, "dueDate": "string", "paidAt": "string", "paymentStatus": "string", "paymentStatusDetail": "string", "invoicePdfUrl": "string", "tryNumber": 0, "billableConnectedCauseCount": 0, "actualConnectedCauseCount": 0, "connectedCauseCap": 0, "includedApiRequests": 0, "apiBillableUnits": 0, "apiOverageUnits": 0, "apiOverageSubtotal": 0, "watchedRuts": 0, "rutMonitorFreeRuts": 0, "rutMonitorBillableRuts": 0, "rutMonitorSubtotal": 0, "billingWarning": "string", "lines": [ { "key": "string", "label": "string", "quantity": "string", "unitAmount": 0, "subtotal": 0 } ], "mpPaymentId": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "invoices": { "items": { "properties": { "actualConnectedCauseCount": { "type": "integer" }, "apiBillableUnits": { "type": "integer" }, "apiOverageSubtotal": { "type": "number" }, "apiOverageUnits": { "type": "integer" }, "billableConnectedCauseCount": { "type": "integer" }, "billingWarning": { "type": [ "string", "null" ] }, "commercialPlan": { "type": "string" }, "connectedCauseCap": { "description": "Maximum number of tracked causas on the plan.", "type": [ "integer", "null" ] }, "dueDate": { "description": "Due date (ISO 8601).", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "includedApiRequests": { "description": "API requests included in the plan per month.", "type": "integer" }, "invoiceNumber": { "type": "integer" }, "invoicePdfUrl": { "type": [ "string", "null" ] }, "lines": { "items": { "properties": { "key": { "description": "Stable key.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "quantity": { "type": "string" }, "subtotal": { "type": "number" }, "unitAmount": { "type": "number" } }, "required": [ "key", "label", "quantity", "unitAmount", "subtotal" ], "type": "object" }, "type": "array" }, "mpPaymentId": { "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "orgName": { "description": "Organization name.", "type": "string" }, "paidAt": { "type": [ "string", "null" ] }, "paymentStatus": { "type": [ "string", "null" ] }, "paymentStatusDetail": { "type": [ "string", "null" ] }, "rutMonitorBillableRuts": { "type": "integer" }, "rutMonitorFreeRuts": { "type": "integer" }, "rutMonitorSubtotal": { "type": "number" }, "status": { "description": "Current status.", "type": "string" }, "subscription": { "description": "The organization's subscription.", "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" }, "tryNumber": { "type": "integer" }, "watchedRuts": { "description": "RUTs under monitoring.", "type": "integer" } }, "required": [ "id", "orgId", "orgName", "invoiceNumber", "status", "subscription", "commercialPlan", "total", "dueDate", "paidAt", "paymentStatus", "paymentStatusDetail", "invoicePdfUrl", "tryNumber", "billableConnectedCauseCount", "actualConnectedCauseCount", "connectedCauseCap", "includedApiRequests", "apiBillableUnits", "apiOverageUnits", "apiOverageSubtotal", "watchedRuts", "rutMonitorFreeRuts", "rutMonitorBillableRuts", "rutMonitorSubtotal", "billingWarning", "lines", "mpPaymentId" ], "type": "object" }, "type": "array" }, "organizationIds": { "items": { "type": "string" }, "type": "array" }, "organizations": { "description": "Organizations.", "items": { "properties": { "activeConnectedCauses": { "type": "integer" }, "activeCoupons": { "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "amount": { "description": "Amount.", "type": [ "string", "null" ] }, "code": { "description": "Short code.", "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "descriptionEn": { "type": "string" }, "discount": { "type": [ "number", "null" ] }, "eliminatedAt": { "type": [ "string", "null" ] }, "historyCreatedAt": { "description": "When the history entry was recorded (ISO 8601).", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "quantityLeft": { "type": "integer" }, "remaining": { "type": "string" }, "remainingEn": { "type": "string" }, "valid": { "description": "Whether it is valid.", "type": "boolean" }, "validFrom": { "description": "Valid from (ISO 8601).", "type": "string" }, "validUntil": { "description": "Valid until (ISO 8601).", "type": "string" } }, "required": [ "kind", "description", "descriptionEn", "remaining", "remainingEn", "id", "code", "active", "valid", "quantityLeft", "validFrom", "validUntil", "amount", "discount", "historyCreatedAt", "eliminatedAt" ], "type": "object" }, "type": "array" }, "apiBillableUnitsCurrentMonth": { "type": "integer" }, "apiIncludedRequestsPerCause": { "type": "integer" }, "apiOverageUnitsCurrentMonth": { "type": "integer" }, "billableConnectedCauses": { "type": "integer" }, "billingWarning": { "description": "Billing warning for the organization; currently always null here.", "type": [ "string", "null" ] }, "commercialPlan": { "type": "string" }, "connectedCauseCap": { "description": "Maximum number of tracked causas on the plan.", "type": [ "integer", "null" ] }, "couponHistory": { "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "amount": { "description": "Amount.", "type": [ "string", "null" ] }, "code": { "description": "Short code.", "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "descriptionEn": { "type": "string" }, "discount": { "type": [ "number", "null" ] }, "eliminatedAt": { "type": [ "string", "null" ] }, "historyCreatedAt": { "description": "When the history entry was recorded (ISO 8601).", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "quantityLeft": { "type": "integer" }, "remaining": { "type": "string" }, "remainingEn": { "type": "string" }, "valid": { "description": "Whether it is valid.", "type": "boolean" }, "validFrom": { "description": "Valid from (ISO 8601).", "type": "string" }, "validUntil": { "description": "Valid until (ISO 8601).", "type": "string" } }, "required": [ "kind", "description", "descriptionEn", "remaining", "remainingEn", "id", "code", "active", "valid", "quantityLeft", "validFrom", "validUntil", "amount", "discount", "historyCreatedAt", "eliminatedAt" ], "type": "object" }, "type": "array" }, "extraCausaClp": { "type": "integer" }, "financialProfile": { "description": "Billing profile; null when the organization has none.", "properties": { "address": { "description": "Postal address.", "type": "string" }, "cardCount": { "type": "integer" }, "companyName": { "type": "string" }, "comuna": { "type": "string" }, "country": { "type": "string" }, "dteEmail": { "type": "string" }, "giro": { "type": "string" }, "provider": { "description": "Provider.", "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" } }, "required": [ "companyName", "rut", "country", "comuna", "address", "giro", "dteEmail", "cardCount", "provider" ], "type": [ "object", "null" ] }, "hasFinancialProfile": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "includedApiRequests": { "description": "API requests included in the plan per month.", "type": "integer" }, "name": { "description": "Display name.", "type": "string" }, "nextDueDate": { "description": "Due date of the earliest open invoice (ISO 8601); null when none is open.", "type": [ "string", "null" ] }, "openInvoices": { "type": "integer" }, "overdueInvoices": { "type": "integer" }, "provider": { "description": "Provider.", "type": "string" }, "rutMonitorEstimatedInclusive": { "type": "number" }, "rutMonitorExtraRuts": { "type": "integer" }, "rutMonitorFreeRuts": { "type": "integer" }, "rutMonitorPriceInclusive": { "type": "number" }, "serviceUsage": { "type": "null" }, "subscription": { "description": "The organization's subscription.", "type": "string" }, "watchedRuts": { "description": "RUTs under monitoring.", "type": "integer" } }, "required": [ "id", "name", "subscription", "commercialPlan", "connectedCauseCap", "extraCausaClp", "apiIncludedRequestsPerCause", "activeConnectedCauses", "billableConnectedCauses", "includedApiRequests", "apiBillableUnitsCurrentMonth", "apiOverageUnitsCurrentMonth", "billingWarning", "hasFinancialProfile", "provider", "openInvoices", "overdueInvoices", "nextDueDate", "financialProfile", "activeCoupons", "couponHistory", "serviceUsage", "watchedRuts", "rutMonitorFreeRuts", "rutMonitorExtraRuts", "rutMonitorPriceInclusive", "rutMonitorEstimatedInclusive" ], "type": "object" }, "type": "array" }, "resolvedOrganizationId": { "description": "Organization the request was resolved against.", "type": "string" }, "upcomingInvoices": { "description": "Up to 6 open invoices, earliest due first (same rows as invoices).", "items": { "properties": { "actualConnectedCauseCount": { "type": "integer" }, "apiBillableUnits": { "type": "integer" }, "apiOverageSubtotal": { "type": "number" }, "apiOverageUnits": { "type": "integer" }, "billableConnectedCauseCount": { "type": "integer" }, "billingWarning": { "type": [ "string", "null" ] }, "commercialPlan": { "type": "string" }, "connectedCauseCap": { "description": "Maximum number of tracked causas on the plan.", "type": [ "integer", "null" ] }, "dueDate": { "description": "Due date (ISO 8601).", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "includedApiRequests": { "description": "API requests included in the plan per month.", "type": "integer" }, "invoiceNumber": { "type": "integer" }, "invoicePdfUrl": { "type": [ "string", "null" ] }, "lines": { "items": { "properties": { "key": { "description": "Stable key.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "quantity": { "type": "string" }, "subtotal": { "type": "number" }, "unitAmount": { "type": "number" } }, "required": [ "key", "label", "quantity", "unitAmount", "subtotal" ], "type": "object" }, "type": "array" }, "mpPaymentId": { "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "orgName": { "description": "Organization name.", "type": "string" }, "paidAt": { "type": [ "string", "null" ] }, "paymentStatus": { "type": [ "string", "null" ] }, "paymentStatusDetail": { "type": [ "string", "null" ] }, "rutMonitorBillableRuts": { "type": "integer" }, "rutMonitorFreeRuts": { "type": "integer" }, "rutMonitorSubtotal": { "type": "number" }, "status": { "description": "Current status.", "type": "string" }, "subscription": { "description": "The organization's subscription.", "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" }, "tryNumber": { "type": "integer" }, "watchedRuts": { "description": "RUTs under monitoring.", "type": "integer" } }, "required": [ "id", "orgId", "orgName", "invoiceNumber", "status", "subscription", "commercialPlan", "total", "dueDate", "paidAt", "paymentStatus", "paymentStatusDetail", "invoicePdfUrl", "tryNumber", "billableConnectedCauseCount", "actualConnectedCauseCount", "connectedCauseCap", "includedApiRequests", "apiBillableUnits", "apiOverageUnits", "apiOverageSubtotal", "watchedRuts", "rutMonitorFreeRuts", "rutMonitorBillableRuts", "rutMonitorSubtotal", "billingWarning", "lines", "mpPaymentId" ], "type": "object" }, "type": "array" } }, "required": [ "organizationIds", "resolvedOrganizationId", "organizations", "invoices", "upcomingInvoices" ], "type": "object" }, "errorEn": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get client billing workspace data", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/billing/queries/get-plan-options": { "post": { "description": "Get plan options\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-billing-queries-get-plan-options", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "currentPlan": "string", "activeConnectedCauses": 0, "selfService": true, "negotiated": true, "negotiatedTerms": [ { "kind": "variable", "amount": 0, "count": 0 } ], "options": [ { "plan": "string", "monthlyNet": 0, "monthlyInclusive": 0, "causeCap": 0, "extraCausaClp": 0, "extraCauses": 0, "estimatedInclusive": 0, "current": true, "allowed": true, "reason": "string", "upgrade": true, "appliesImmediately": true, "starterBands": [ { "limitInclusive": 0, "priceInclusive": 0 } ] } ], "pendingChange": { "plan": "string", "requestedAt": "string", "appliesAt": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "activeConnectedCauses": { "type": "integer" }, "currentPlan": { "type": "string" }, "negotiated": { "type": "boolean" }, "negotiatedTerms": { "description": "Terms agreed for this organization that a self-service plan change would end.", "items": { "properties": { "amount": { "description": "CLP, VAT included; for annualPrice, monthlyPrice and chargeCeiling.", "type": "integer" }, "count": { "description": "Paid months (annual) or causa cap (causeCap).", "type": "integer" }, "kind": { "description": "Record subtype.", "enum": [ "variable", "annualPrice", "annual", "monthlyPrice", "causeCap", "chargeCeiling" ], "type": "string" } }, "required": [ "kind" ], "type": "object" }, "type": "array" }, "options": { "description": "Available options.", "items": { "properties": { "allowed": { "type": "boolean" }, "appliesImmediately": { "type": "boolean" }, "causeCap": { "type": "integer" }, "current": { "type": "boolean" }, "estimatedInclusive": { "type": "integer" }, "extraCausaClp": { "type": "integer" }, "extraCauses": { "type": "integer" }, "monthlyInclusive": { "type": "integer" }, "monthlyNet": { "type": "integer" }, "plan": { "type": "string" }, "reason": { "description": "Why this happened.", "type": "string" }, "starterBands": { "items": { "properties": { "limitInclusive": { "type": "integer" }, "priceInclusive": { "type": "integer" } }, "required": [ "limitInclusive", "priceInclusive" ], "type": "object" }, "type": "array" }, "upgrade": { "type": "boolean" } }, "required": [ "plan", "monthlyNet", "monthlyInclusive", "causeCap", "extraCausaClp", "extraCauses", "estimatedInclusive", "current", "allowed", "reason", "upgrade", "appliesImmediately" ], "type": "object" }, "type": "array" }, "pendingChange": { "properties": { "appliesAt": { "type": [ "string", "null" ] }, "plan": { "type": "string" }, "requestedAt": { "type": [ "string", "null" ] } }, "required": [ "plan", "requestedAt", "appliesAt" ], "type": "object" }, "selfService": { "type": "boolean" } }, "required": [ "currentPlan", "activeConnectedCauses", "selfService", "negotiated", "negotiatedTerms", "options", "pendingChange" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get plan options", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/boletin-concursal-movements/queries/get-boletin-concursal-movements-section": { "post": { "description": "Get boletin concursal movements section\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-boletin-concursal-movements-queries-get-boletin-concursal-movements-section", "requestBody": { "content": { "application/json": { "example": { "args": [ { "from": "", "hideLiquidador": false, "page": 0, "per_page": 0, "section": "", "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "from": { "type": "string" }, "hideLiquidador": { "type": "boolean" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "section": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "section": { "slug": "string", "total": 0, "pageCount": 0, "rows": [ { "id": "string", "causaBcId": "string", "rol": "string", "causaId": "string", "procedimientoNombre": "string", "nombre": "string", "numero": "string", "materia": "string", "estado": "string", "fecha": "2026-01-31T12:00:00Z", "documentoUrl": "string", "documentoStoragePath": "string", "createdAt": "2026-01-31T12:00:00Z" } ] } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "section": { "description": "The requested section.", "properties": { "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "rows": { "description": "Rows of the requested section (publicacion, etapa or actuacion).", "items": { "properties": { "causaBcId": { "description": "CausaBoletinConcursal id.", "type": "string" }, "causaId": { "description": "Linked PJUD causa, if any.", "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "documentoStoragePath": { "description": "publicacion and actuacion only: handle of the stored copy; pass it with causaBcId to get-liquidacion-document-url for a download link.", "type": [ "string", "null" ] }, "documentoUrl": { "description": "publicacion and actuacion only: document URL on boletinconcursal.cl.", "type": [ "string", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Publication / action date, or the stage's estimated date.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "materia": { "description": "actuacion only.", "type": "string" }, "nombre": { "description": "publicacion and etapa only.", "type": "string" }, "numero": { "description": "actuacion only.", "type": [ "string", "null" ] }, "procedimientoNombre": { "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] } }, "required": [ "id", "causaBcId", "rol", "causaId", "procedimientoNombre", "estado", "fecha", "createdAt" ], "type": "object" }, "type": "array" }, "slug": { "description": "URL-safe identifier.", "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "slug", "total", "pageCount", "rows" ], "type": "object" } }, "required": [ "section" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get boletin concursal movements section", "tags": [ "Insolvency Bulletin" ], "x-required-scope": "causas:read" } }, "/api/actions/boletin-concursal-movements/queries/get-boletin-concursal-movements-section-counts": { "post": { "description": "Get boletin concursal movements section counts\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-boletin-concursal-movements-queries-get-boletin-concursal-movements-section-counts", "requestBody": { "content": { "application/json": { "example": { "args": [ { "from": "", "hideLiquidador": false, "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "from": { "type": "string" }, "hideLiquidador": { "type": "boolean" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "counts": { "publicacion": 0, "etapa": 0, "actuacion": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "counts": { "description": "Totals per category.", "properties": { "actuacion": { "type": "integer" }, "etapa": { "description": "Procedural stage.", "type": "integer" }, "publicacion": { "type": "integer" } }, "required": [ "publicacion", "etapa", "actuacion" ], "type": "object" } }, "required": [ "counts" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get boletin concursal movements section counts", "tags": [ "Insolvency Bulletin" ], "x-required-scope": "causas:read" } }, "/api/actions/boletin-queue/queries/get-boletin-upload-queue": { "post": { "description": "Get boletin upload queue\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-boletin-queue-queries-get-boletin-upload-queue", "requestBody": { "content": { "application/json": { "example": { "args": [ { "page": 0, "per_page": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "page": { "type": "number" }, "per_page": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "id": "string", "causaId": "string", "rol": "string", "caratulado": "string", "sourceId": "string", "publicationType": "string", "state": "string", "attempts": 0, "errorMessage": "string", "portalPubId": "string", "createdAt": "string", "completedAt": "string" } ], "total": 0, "pageCount": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "rows": { "description": "The records on this page.", "items": { "properties": { "attempts": { "description": "Number of attempts.", "type": "integer" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "completedAt": { "description": "When it finished (ISO 8601).", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "type": "string" }, "errorMessage": { "description": "Error message.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "portalPubId": { "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "sourceId": { "description": "Id of the record in its source.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "causaId", "rol", "caratulado", "sourceId", "publicationType", "state", "attempts", "errorMessage", "portalPubId", "createdAt" ], "type": "object" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "rows", "total", "pageCount" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get boletin upload queue", "tags": [ "Insolvency Bulletin" ], "x-required-scope": "causas:read" } }, "/api/actions/boletin-tracking/get-boletin-tracking-detail": { "post": { "description": "Get boletin tracking detail\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-boletin-tracking-get-boletin-tracking-detail", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaBcId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaBcId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "procedure": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "procedure": { "type": "string" } }, "required": [ "procedure" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get boletin tracking detail", "tags": [ "Insolvency Bulletin" ], "x-required-scope": "causas:read" } }, "/api/actions/boletin-tracking/list-boletin-tracking": { "post": { "description": "List boletin tracking\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-boletin-tracking-list-boletin-tracking", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "available": false, "causaBcId": "", "page": 0, "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "available": { "type": "boolean" }, "causaBcId": { "type": "string" }, "page": { "type": "number" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "causaBcId": "string", "source": "PUBLIC", "documentId": "string", "nombre": "string", "rol": "string", "tribunal": "string", "estado": "string", "trackingId": "string", "active": true, "assignedUserIds": [ "string" ], "assignedTeamIds": [ "string" ], "lastViewedAt": "2026-01-31T12:00:00Z", "fecha": "2026-01-31T12:00:00Z", "deudorRut": "string", "tipoProcedimiento": "string", "ultimaGestion": "string", "fechaGestion": "2026-01-31T12:00:00Z", "cantidadGestiones": 0, "movementCount": true } ], "page": 0, "pageSize": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "page": { "description": "Current page number (1-based).", "type": "integer" }, "pageSize": { "type": "integer" }, "rows": { "description": "The records on this page.", "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "assignedTeamIds": { "items": { "type": "string" }, "type": "array" }, "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "cantidadGestiones": { "description": "Number of collection actions.", "type": [ "integer", "null" ] }, "causaBcId": { "type": "string" }, "deudorRut": { "description": "Debtor's RUT.", "type": [ "string", "null" ] }, "documentId": { "description": "Document id.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaGestion": { "format": "date-time", "type": [ "string", "null" ] }, "lastViewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "movementCount": { "type": "boolean" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "enum": [ "PUBLIC", "LIQUIDADOR" ], "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] }, "trackingId": { "type": "string" }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "ultimaGestion": { "description": "Last collection action (ISO 8601).", "type": [ "string", "null" ] } }, "required": [ "causaBcId", "source", "documentId", "nombre", "rol", "tribunal", "estado", "trackingId", "active" ], "type": "object" }, "type": "array" } }, "required": [ "rows" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List boletin tracking", "tags": [ "Insolvency Bulletin" ], "x-required-scope": "causas:read" } }, "/api/actions/boletin-tracking/set-boletin-tracking": { "post": { "description": "Set boletin tracking\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-boletin-tracking-set-boletin-tracking", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "available": false, "causaBcId": "", "page": 0, "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "available": { "type": "boolean" }, "causaBcId": { "type": "string" }, "page": { "type": "number" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "trackingId": "string", "active": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "trackingId": { "type": "string" } }, "required": [ "trackingId", "active" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set boletin tracking", "tags": [ "Insolvency Bulletin" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/calls/mutations/create-call-guest-invite": { "post": { "description": "Create call guest invite\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-calls-mutations-create-call-guest-invite", "requestBody": { "content": { "application/json": { "example": { "args": [ { "callId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "callId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "token": "string", "expiresAt": "2026-01-31T12:00:00Z", "path": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "expiresAt": { "format": "date-time", "type": "string" }, "path": { "description": "Path relative to the API host.", "type": "string" }, "token": { "description": "Opaque token.", "type": "string" } }, "required": [ "token", "expiresAt", "path" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create call guest invite", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/calls/mutations/decline-call": { "post": { "description": "Decline call\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-calls-mutations-decline-call", "requestBody": { "content": { "application/json": { "example": { "args": [ { "callId": "", "skipVoIP": false } ] }, "schema": { "properties": { "args": { "items": { "properties": { "callId": { "type": "string" }, "skipVoIP": { "type": "boolean" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "call": { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "string", "state": "string", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "call": { "description": "The call.", "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endReason": { "description": "Why the call ended.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": [ "object", "null" ] } }, "required": [ "call" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Decline call", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/calls/mutations/end-call": { "post": { "description": "End call\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-calls-mutations-end-call", "requestBody": { "content": { "application/json": { "example": { "args": [ { "callId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "callId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "call": { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "string", "state": "string", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "call": { "description": "The call.", "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endReason": { "description": "Why the call ended.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": [ "object", "null" ] } }, "required": [ "call" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "End call", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/calls/mutations/join-call": { "post": { "description": "Join call\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-calls-mutations-join-call", "requestBody": { "content": { "application/json": { "example": { "args": [ { "callId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "callId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "token": "string", "roomName": "string", "identity": "string", "role": "string", "call": { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "string", "state": "string", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "call": { "description": "The call.", "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endReason": { "description": "Why the call ended.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": [ "object", "null" ] }, "identity": { "description": "Participant identity.", "type": "string" }, "role": { "description": "Role.", "type": "string" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "token": { "description": "Opaque token.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url", "token", "roomName", "identity", "role", "call" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Join call", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/calls/mutations/start-call": { "post": { "description": "Start call\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-calls-mutations-start-call", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "", "kind": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" }, "kind": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "call": { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "string", "state": "string", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0 }, "existing": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "call": { "description": "The call.", "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endReason": { "description": "Why the call ended.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": [ "object", "null" ] }, "existing": { "type": "boolean" } }, "required": [ "call" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start call", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/calls/queries/get-active-call": { "post": { "description": "Get active call\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-calls-queries-get-active-call", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "call": { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "string", "state": "string", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0, "startedByName": "string", "participants": [ { "userId": "string", "name": "string", "identity": "string", "role": "HOST", "state": "string", "joinedAt": "2026-01-31T12:00:00Z", "leftAt": "2026-01-31T12:00:00Z", "guest": true } ] }, "enabled": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "call": { "description": "The call.", "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endReason": { "description": "Why the call ended.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "participants": { "description": "Participants.", "items": { "properties": { "guest": { "type": "boolean" }, "identity": { "description": "LiveKit participant identity.", "type": "string" }, "joinedAt": { "format": "date-time", "type": [ "string", "null" ] }, "leftAt": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "User name, or the guest's name.", "type": "string" }, "role": { "description": "Role.", "enum": [ "HOST", "PARTICIPANT", "GUEST" ], "type": "string" }, "state": { "description": "Participant state (INVITED, WAITING, JOINED, LEFT, DECLINED).", "type": "string" }, "userId": { "description": "Empty for a guest.", "type": "string" } }, "required": [ "userId", "name", "identity", "role", "state", "joinedAt", "leftAt", "guest" ], "type": "object" }, "type": "array" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "startedByName": { "description": "Name of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": [ "object", "null" ] }, "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" } }, "required": [ "call", "enabled" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get active call", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/calls/queries/list-call-history": { "post": { "description": "List call history\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-calls-queries-list-call-history", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "calls": [ { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "string", "state": "string", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0, "startedByName": "string", "joinedCount": 0, "mine": true } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "calls": { "items": { "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endReason": { "description": "Why the call ended.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "joinedCount": { "type": "integer" }, "kind": { "description": "Record subtype.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "mine": { "description": "Whether it belongs to the API key's acting user.", "type": "boolean" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "startedByName": { "description": "Name of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": "object" }, "type": "array" } }, "required": [ "calls" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List call history", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/case-activity/mutations/delete-boletin-publication-upload": { "post": { "description": "Delete boletin publication upload\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-activity-mutations-delete-boletin-publication-upload", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "sourceId": "", "sourceType": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "success": true }, "schema": { "properties": { "success": { "description": "Whether the action completed.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete boletin publication upload", "tags": [ "Insolvency Bulletin" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-activity/mutations/queue-boletin-publication-upload": { "post": { "description": "Queue boletin publication upload\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-activity-mutations-queue-boletin-publication-upload", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "comentario": "", "sourceId": "", "sourceType": "", "tipoPublicacion": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "comentario": { "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" }, "tipoPublicacion": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "success": true, "jobId": "string", "alreadyQueued": true }, "schema": { "properties": { "alreadyQueued": { "description": "Whether an identical job was already queued.", "type": "boolean" }, "jobId": { "description": "Background job id.", "type": "string" }, "success": { "description": "Whether the action completed.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Queue boletin publication upload", "tags": [ "Insolvency Bulletin" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-activity/mutations/queue-case-activity-export": { "post": { "description": "Queue case activity export\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-activity-mutations-queue-case-activity-export", "requestBody": { "content": { "application/json": { "example": { "args": [ { "from": "", "hideLiquidacionCausas": false, "hideReviewed": false, "kind": "", "page": 0, "per_page": 0, "section": "", "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "from": { "type": "string" }, "hideLiquidacionCausas": { "type": "boolean" }, "hideReviewed": { "type": "boolean" }, "kind": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "section": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "success": true, "jobId": "string", "alreadyQueued": true }, "schema": { "properties": { "alreadyQueued": { "description": "Whether an identical job was already queued.", "type": "boolean" }, "jobId": { "description": "Background job id.", "type": "string" }, "success": { "description": "Whether the action completed.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Queue case activity export", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-activity/mutations/set-case-activity-reviewed": { "post": { "description": "Set case activity reviewed\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-activity-mutations-set-case-activity-reviewed", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "reviewed": false, "section": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "reviewed": { "type": "boolean" }, "section": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "section": "string", "id": "string", "reviewed": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "reviewed": { "type": "boolean" }, "section": { "description": "The requested section.", "type": "string" } }, "required": [ "section", "id", "reviewed" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set case activity reviewed", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-activity/mutations/upload-boletin-publication": { "post": { "description": "Upload a Boletín publication document\n\nAuthentication: developer API key with `causas:write` scope. Multipart form fields: `causaId`, `sourceType`, `sourceId`, `tipoPublicacion`, optional `comentario`, and file `docResolucion`.", "operationId": "actions-case-activity-mutations-upload-boletin-publication", "requestBody": { "content": { "multipart/form-data": { "example": { "causaId": "\u003cCAUSA_ID\u003e", "docResolucion": "@/path/to/file.pdf", "sourceId": "\u003cSOURCE_ID\u003e", "sourceType": "\u003cSOURCE_TYPE\u003e", "tipoPublicacion": "\u003cTIPO_PUBLICACION\u003e" }, "schema": { "properties": { "causaId": { "type": "string" }, "comentario": { "type": "string" }, "docResolucion": { "default": "@/path/to/file.pdf", "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" }, "tipoPublicacion": { "type": "string" } }, "required": [ "causaId", "sourceType", "sourceId", "tipoPublicacion", "docResolucion" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "success": true, "status": "string", "verified": true, "publicationType": "string" }, "schema": { "properties": { "publicationType": { "description": "Publication type.", "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "success": { "description": "Whether the action completed.", "type": "boolean" }, "verified": { "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload boletin publication", "tags": [ "Insolvency Bulletin" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-activity/queries/get-case-activity-document-url": { "post": { "description": "Signed URL for a movement document.\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-activity-queries-get-case-activity-document-url", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "\u003cMOVEMENT_ID\u003e", "path": "\u003cDOCUMENT_PATH\u003e", "section": "historia" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "section": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "recoveryQueued": true, "url": "string", "previewUrl": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "previewUrl": { "description": "Short-lived URL to preview the file.", "type": "string" }, "recoveryQueued": { "description": "Whether a recovery job was queued.", "type": "boolean" }, "url": { "description": "Absolute URL.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get case activity document url", "tags": [ "Expedientes and activity" ], "x-required-scope": "causas:read" } }, "/api/actions/case-activity/queries/get-case-activity-export-queue": { "post": { "description": "Get case activity export queue\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-activity-queries-get-case-activity-export-queue", "requestBody": { "content": { "application/json": { "example": { "args": [ { "limit": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "limit": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "id": "string", "kind": "string", "section": "string", "from": "string", "to": "string", "state": "string", "attempts": 0, "progressCurrent": 0, "progressTotal": 0, "errorMessage": "string", "fileName": "string", "bytes": 0, "downloadable": true, "createdAt": "string", "completedAt": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "rows": { "description": "The records on this page.", "items": { "properties": { "attempts": { "description": "Number of attempts.", "type": "integer" }, "bytes": { "description": "Size in bytes.", "type": "integer" }, "completedAt": { "description": "When it finished (ISO 8601).", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "type": "string" }, "downloadable": { "type": "boolean" }, "errorMessage": { "description": "Error message.", "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "from": { "description": "Start of the range (ISO 8601).", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "progressCurrent": { "type": "integer" }, "progressTotal": { "type": "integer" }, "section": { "description": "The requested section.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "to": { "description": "End of the range (ISO 8601).", "type": "string" } }, "required": [ "id", "kind", "section", "from", "to", "state", "attempts", "progressCurrent", "progressTotal", "errorMessage", "fileName", "bytes", "downloadable", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "rows" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get case activity export queue", "tags": [ "Expedientes and activity" ], "x-required-scope": "causas:read" } }, "/api/actions/case-activity/queries/get-case-activity-section-counts": { "post": { "description": "Counts of recent movements per section.\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-activity-queries-get-case-activity-section-counts", "requestBody": { "content": { "application/json": { "example": { "args": [ { "from": "", "hideAutoRelated": false, "hideLiquidacionCausas": false, "hideReviewed": false, "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "from": { "type": "string" }, "hideAutoRelated": { "type": "boolean" }, "hideLiquidacionCausas": { "type": "boolean" }, "hideReviewed": { "type": "boolean" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "counts": { "historia": 0, "notificacion": 0, "escritoPorResolver": 0, "exhorto": 0, "notificacionReceptor": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "counts": { "description": "Totals per category.", "properties": { "escritoPorResolver": { "type": "integer" }, "exhorto": { "type": "integer" }, "historia": { "description": "Movement history, newest first.", "type": "integer" }, "notificacion": { "type": "integer" }, "notificacionReceptor": { "type": "integer" } }, "required": [ "historia", "notificacion", "escritoPorResolver", "exhorto", "notificacionReceptor" ], "type": "object" } }, "required": [ "counts" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get case activity section counts", "tags": [ "Expedientes and activity" ], "x-required-scope": "causas:read" } }, "/api/actions/case-law/get-case-law-document": { "post": { "description": "Get case law document\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-law-get-case-law-document", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003cjurisID\u003e", { "buscador": "", "includeHtml": false } ] }, "schema": { "properties": { "args": { "prefixItems": [ { "description": "jurisID", "type": "string" }, { "properties": { "buscador": { "type": "string" }, "includeHtml": { "type": "boolean" } }, "type": "object" } ], "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "jurisId": "string", "buscador": "string", "caratulado": "string", "caratuladoAnon": "string", "corte": "string", "sala": "string", "rolEraApe": "string", "resultadoRecurso": "string", "fecSentenciaSup": "string", "urlAccesoSentencia": "string", "urlCortaAccesoSentencia": "string", "citaBibliografica": "string", "privilegio": "string", "titulo": "string", "tribunal": "string", "rol": "string", "materia": "string", "origen": "string", "resultado": "string", "descriptores": [ "string" ], "normas": [ "string" ], "ministros": [ "string" ], "redactor": "string", "textoSentenciaText": "string", "textoSentenciaAnonText": "string", "textoSentenciaHtml": "string", "textoSentenciaAnonHtml": "string", "textoSentenciaPreview": "string" }, "schema": { "properties": { "buscador": { "description": "Case-law source (PJUD buscador).", "type": "string" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "caratuladoAnon": { "description": "Anonymized caption.", "type": "string" }, "citaBibliografica": { "description": "Bibliographic citation.", "type": "string" }, "corte": { "description": "Court of appeals name.", "type": "string" }, "descriptores": { "description": "Subject descriptors.", "items": { "type": "string" }, "type": "array" }, "fecSentenciaSup": { "description": "Date of the Supreme Court ruling (ISO 8601).", "type": "string" }, "jurisId": { "description": "Ruling id at the PJUD case-law search.", "type": "string" }, "materia": { "description": "Subject matter.", "type": "string" }, "ministros": { "items": { "type": "string" }, "type": "array" }, "normas": { "items": { "type": "string" }, "type": "array" }, "origen": { "description": "Where the case came from.", "type": "string" }, "privilegio": { "type": "string" }, "redactor": { "type": "string" }, "resultado": { "type": "string" }, "resultadoRecurso": { "description": "Outcome of the appeal.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "rolEraApe": { "type": "string" }, "sala": { "description": "Court chamber (sala).", "type": "string" }, "textoSentenciaAnonHtml": { "type": "string" }, "textoSentenciaAnonText": { "type": "string" }, "textoSentenciaHtml": { "type": "string" }, "textoSentenciaPreview": { "type": "string" }, "textoSentenciaText": { "type": "string" }, "titulo": { "description": "Title.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" }, "urlAccesoSentencia": { "description": "URL of the ruling at PJUD.", "type": "string" }, "urlCortaAccesoSentencia": { "description": "Short URL of the ruling at PJUD.", "type": "string" } }, "required": [ "jurisId", "buscador" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reference:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reference:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reference:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get case law document", "tags": [ "Expedientes and activity" ], "x-required-scope": "reference:read" } }, "/api/actions/case-law/list-case-law-documents": { "post": { "description": "List case law documents\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-law-list-case-law-documents", "requestBody": { "content": { "application/json": { "example": { "args": [ { "buscador": "", "cursor": "", "dateFrom": "", "dateTo": "", "includeTotal": false, "page": 0, "pageSize": 0, "q": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "buscador": { "type": "string" }, "cursor": { "type": "string" }, "dateFrom": { "type": "string" }, "dateTo": { "type": "string" }, "includeTotal": { "type": "boolean" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "q": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "page": 0, "pageSize": 0, "total": 0, "totalPages": 0, "totalCapped": true, "items": [ { "jurisId": "string", "buscador": "string", "caratulado": "string", "caratuladoAnon": "string", "corte": "string", "sala": "string", "rolEraApe": "string", "resultadoRecurso": "string", "fecSentenciaSup": "string", "urlAccesoSentencia": "string", "urlCortaAccesoSentencia": "string", "citaBibliografica": "string", "privilegio": "string", "snippet": "string", "titulo": "string", "tribunal": "string", "rol": "string", "materia": "string", "origen": "string", "resultado": "string", "descriptores": [ "string" ] } ], "nextCursor": "string", "hasMore": true }, "schema": { "properties": { "hasMore": { "type": "boolean" }, "items": { "description": "The records returned.", "items": { "properties": { "buscador": { "description": "Case-law source (PJUD buscador).", "type": "string" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "caratuladoAnon": { "description": "Anonymized caption.", "type": "string" }, "citaBibliografica": { "description": "Bibliographic citation.", "type": "string" }, "corte": { "description": "Court of appeals name.", "type": "string" }, "descriptores": { "description": "Subject descriptors.", "items": { "type": "string" }, "type": "array" }, "fecSentenciaSup": { "description": "Date of the Supreme Court ruling (ISO 8601).", "type": "string" }, "jurisId": { "description": "Ruling id at the PJUD case-law search.", "type": "string" }, "materia": { "description": "Subject matter.", "type": "string" }, "origen": { "description": "Where the case came from.", "type": "string" }, "privilegio": { "type": "string" }, "resultado": { "type": "string" }, "resultadoRecurso": { "description": "Outcome of the appeal.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "rolEraApe": { "type": "string" }, "sala": { "description": "Court chamber (sala).", "type": "string" }, "snippet": { "type": "string" }, "titulo": { "description": "Title.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" }, "urlAccesoSentencia": { "description": "URL of the ruling at PJUD.", "type": "string" }, "urlCortaAccesoSentencia": { "description": "Short URL of the ruling at PJUD.", "type": "string" } }, "required": [ "jurisId", "buscador" ], "type": "object" }, "type": "array" }, "nextCursor": { "type": "string" }, "page": { "description": "Current page number (1-based).", "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" }, "totalCapped": { "type": "boolean" }, "totalPages": { "type": "integer" } }, "required": [ "page", "pageSize", "total", "totalPages", "items" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reference:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reference:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reference:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List case law documents", "tags": [ "Expedientes and activity" ], "x-required-scope": "reference:read" } }, "/api/actions/case-tracking/bitacora-mutations/delete-tracked-case-bitacora": { "post": { "description": "Delete one bitácora note of a causa. args[0]: {id, caseId, orgId}.\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-bitacora-mutations-delete-tracked-case-bitacora", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "\u003cCASE_ID\u003e", "id": "\u003cBITACORA_ID\u003e", "orgId": "\u003cORG_ID\u003e" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" }, "id": { "type": "string" }, "orgId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete tracked case bitacora", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/bitacora-mutations/upsert-tracked-case-bitacora": { "post": { "description": "Create (no id) or edit (with id) a bitácora note on a causa.\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-bitacora-mutations-upsert-tracked-case-bitacora", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "\u003cCASE_ID\u003e", "content": "Se acordó presentar escrito.", "orgId": "\u003cORG_ID\u003e", "title": "Llamada con cliente" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" }, "content": { "type": "string" }, "id": { "type": "string" }, "orgId": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "bitacora": { "id": "string", "title": "string", "content": "string", "orgId": "string", "causeId": "string", "modifiedById": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "bitacora": { "properties": { "causeId": { "type": [ "string", "null" ] }, "content": { "description": "Content.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "modifiedById": { "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "content", "orgId", "causeId", "modifiedById", "createdAt", "updatedAt" ], "type": [ "object", "null" ] } }, "required": [ "bitacora" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upsert tracked case bitacora", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/accept-cause-lineage-suggestion": { "post": { "description": "Accept causa lineage suggestion\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-accept-cause-lineage-suggestion", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "decision": "", "internalCauseId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "decision": { "type": "string" }, "internalCauseId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Accept causa lineage suggestion", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/archive-tracked-cases": { "post": { "description": "Archive (stop following) or unarchive tracked causas, up to 200 per call. args[0]: {caseIds, archived, reason}. Needs an acting role of LAWYER or SUPERVISOR; a PARALEGAL key gets 403.\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-archive-tracked-cases", "requestBody": { "content": { "application/json": { "example": { "args": [ { "archived": true, "caseIds": [ "\u003cCASE_ID\u003e" ], "reason": "Causa terminada" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "archived": { "type": "boolean" }, "caseIds": { "items": { "type": "string" }, "type": "array" }, "reason": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "archived": 0, "requested": 0, "skipped": [ { "caseId": "string", "reason": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "archived": { "description": "Whether the record is archived.", "type": "integer" }, "requested": { "description": "Number of items requested.", "type": "integer" }, "skipped": { "description": "Number of items skipped.", "items": { "properties": { "caseId": { "description": "Case id; see `caseType` for which kind.", "type": "string" }, "reason": { "description": "Why this happened.", "type": "string" } }, "required": [ "caseId", "reason" ], "type": "object" }, "type": "array" } }, "required": [ "archived", "requested", "skipped" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Archive tracked cases", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/assign-cause-team": { "post": { "description": "Assign causa team\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-assign-cause-team", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "teamId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "teamId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Assign causa team", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/assign-cause-team-bulk": { "post": { "description": "Assign causa team bulk\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-assign-cause-team-bulk", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaIds": [], "teamId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaIds": { "items": { "type": "string" }, "type": "array" }, "teamId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "updated": 0, "requested": 0, "skipped": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "requested": { "description": "Number of items requested.", "type": "integer" }, "skipped": { "description": "Number of items skipped.", "items": { "type": "string" }, "type": "array" }, "updated": { "description": "Whether anything changed.", "type": "integer" } }, "required": [ "updated", "requested", "skipped" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Assign causa team bulk", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/cancel-queued-tracked-case-search": { "post": { "description": "Cancel queued tracked case search\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-cancel-queued-tracked-case-search", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Cancel queued tracked case search", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/create-tracked-case": { "post": { "description": "Start tracking a causa for the organization (counts against the plan's causa cap). args[0]: competence (CIVIL, LABORAL, COBRANZA, FAMILIA, PENAL, APELACIONES, SUPREMA), the RIT/ROL split as libro + val + year (C-1234-2024 → \"C\", \"1234\", \"2024\"), corteId and tribunalId from get-ojv-catalogs, and orgId = the API key's organization.\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-create-tracked-case", "requestBody": { "content": { "application/json": { "example": { "args": [ { "clientIds": [], "competence": "CIVIL", "corteId": 90, "libro": "C", "orgId": "\u003cORG_ID\u003e", "private": false, "teamIds": [], "tribunalId": 259, "val": "1234", "year": "2024" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "clientIds": { "items": { "type": "string" }, "type": "array" }, "competence": { "type": "string" }, "corteId": { "type": "number" }, "internalCaseId": { "type": "string" }, "libro": { "type": "string" }, "newInternalCase": { "type": "object" }, "ojvCaratulado": { "type": "string" }, "orgId": { "type": "string" }, "private": { "type": "boolean" }, "resolvedCredentialClientId": { "type": "string" }, "resolvedCredentialSource": { "type": "string" }, "teamIds": { "items": { "type": "string" }, "type": "array" }, "tribunalId": { "type": "number" }, "val": { "type": "string" }, "year": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "cause": { "id": "string", "rol": "string", "competence": "string", "corteId": 0, "tribunalId": 0, "isPrivate": true, "caratulado": "string" }, "internalCase": { "id": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "cause": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": "integer" }, "id": { "description": "Unique identifier.", "type": "string" }, "isPrivate": { "description": "Whether only its members can see it.", "type": "boolean" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" } }, "required": [ "id", "rol", "competence", "corteId", "tribunalId", "isPrivate", "caratulado" ], "type": "object" }, "internalCase": { "description": "The linked expediente.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "cause", "internalCase" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create tracked case", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/generate-cause-ebook": { "post": { "description": "Generate cause ebook\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-generate-cause-ebook", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "path": "string", "fojas": 0, "attached": 0, "bytes": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "attached": { "type": "integer" }, "bytes": { "description": "Size in bytes.", "type": "integer" }, "fojas": { "type": "integer" }, "path": { "description": "Path relative to the API host.", "type": "string" } }, "required": [ "path", "fojas", "attached", "bytes" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Generate cause ebook", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/queue-tracked-case-search": { "post": { "description": "Queue tracked case search\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-queue-tracked-case-search", "requestBody": { "content": { "application/json": { "example": { "args": [ { "creationKey": "", "internalCaseId": "", "label": "", "reason": "", "search": { "clientIds": [], "competence": "", "corteId": 0, "libro": "", "orgId": "", "private": false, "teamIds": [], "tribunalId": 0, "val": "", "year": "" } } ] }, "schema": { "properties": { "args": { "items": { "properties": { "creationKey": { "type": "string" }, "internalCaseId": { "type": "string" }, "label": { "type": "string" }, "reason": { "type": "string" }, "search": { "type": "object" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "alreadyQueued": true, "reason": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "alreadyQueued": { "description": "Whether an identical job was already queued.", "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "reason": { "description": "Why this happened.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Queue tracked case search", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/refresh-tracked-case-detail": { "post": { "description": "Queue a fresh PJUD scrape of one causa. args[0]: {caseId}.\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-refresh-tracked-case-detail", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "\u003cCASE_ID\u003e" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "result": { "status": "string", "causeName": "string" }, "status": "string", "refreshedAt": "string", "trackedCase": { "boletinConcursal": { "id": "string", "documentId": "string", "source": "L", "product": "liquidador", "estado": "string", "tipoProcedimiento": "string", "liquidador": "string", "publications": 0 }, "id": "string", "status": "string", "successValidUntil": "2026-01-31T12:00:00Z", "lastUpdate": "2026-01-31T12:00:00Z", "lastChangeAt": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "refreshedAt": { "type": "string" }, "result": { "description": "The scraper run's own answer.", "properties": { "causeName": { "type": "string" }, "status": { "description": "Scraper outcome text (\"Archived cause\" when the causa is archived and was not scraped).", "type": "string" } }, "required": [ "status", "causeName" ], "type": "object" }, "status": { "description": "Current status.", "type": "string" }, "trackedCase": { "description": "The tracked causa.", "properties": { "boletinConcursal": { "description": "The linked Boletín Concursal procedimiento; null when the causa has none.", "properties": { "documentId": { "description": "Boletín Concursal procedimiento id.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "liquidador": { "type": "string" }, "product": { "enum": [ "liquidador", "public" ], "type": "string" }, "publications": { "description": "Publications.", "type": "integer" }, "source": { "description": "L: this org's liquidador portal; P: public registry.", "enum": [ "L", "P" ], "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" } }, "required": [ "id", "documentId", "source", "product", "estado", "tipoProcedimiento", "liquidador", "publications" ], "type": [ "object", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "lastChangeAt": { "description": "When PJUD last showed a change (ISO 8601).", "type": [ "string", "null" ] }, "lastUpdate": { "description": "Last time the causa was refreshed from PJUD (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "status": { "description": "Current status.", "type": "string" }, "successValidUntil": { "description": "Until when the last successful refresh is considered current (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "boletinConcursal", "id", "status", "successValidUntil", "lastUpdate", "lastChangeAt" ], "type": "object" } }, "required": [ "result", "status", "refreshedAt", "trackedCase" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Refresh tracked case detail", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/mutations/update-queued-tracked-case-search": { "post": { "description": "Update queued tracked case search\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-mutations-update-queued-tracked-case-search", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "op": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "op": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update queued tracked case search", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/note-mutations/upsert-tracked-case-note": { "post": { "description": "Upsert tracked case note\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-note-mutations-upsert-tracked-case-note", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "", "cuadernoName": "", "itemDesc": "", "orgId": "", "relationId": "", "relationName": "", "text": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" }, "cuadernoName": { "type": "string" }, "itemDesc": { "type": "string" }, "orgId": { "type": "string" }, "relationId": { "type": "string" }, "relationName": { "type": "string" }, "text": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "note": { "id": "string", "text": "string", "itemDesc": "string", "orgId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "historiaId": "string", "litiganteId": "string", "exhortoId": "string", "notificacionId": "string", "diligenciaId": "string", "relacionCausaId": "string", "escritoPorResolverId": "string", "plazoId": "string", "audioId": "string", "notificacionReceptorId": "string", "anexoRef": "string", "causeId": "string", "cuadernoName": "string", "modifiedById": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "note": { "description": "The saved note; null when empty text deleted it.", "properties": { "anexoRef": { "description": "Document token of the annotated anexo.", "type": [ "string", "null" ] }, "audioId": { "type": [ "string", "null" ] }, "causeId": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "cuadernoName": { "type": [ "string", "null" ] }, "diligenciaId": { "type": [ "string", "null" ] }, "escritoPorResolverId": { "type": [ "string", "null" ] }, "exhortoId": { "type": [ "string", "null" ] }, "historiaId": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "itemDesc": { "description": "Label of the annotated item, as shown when the note was written.", "type": "string" }, "litiganteId": { "type": [ "string", "null" ] }, "modifiedById": { "type": "string" }, "notificacionId": { "type": [ "string", "null" ] }, "notificacionReceptorId": { "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "plazoId": { "type": [ "string", "null" ] }, "relacionCausaId": { "type": [ "string", "null" ] }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "itemDesc", "orgId", "createdAt", "updatedAt", "historiaId", "litiganteId", "exhortoId", "notificacionId", "diligenciaId", "relacionCausaId", "escritoPorResolverId", "plazoId", "audioId", "notificacionReceptorId", "anexoRef", "causeId", "cuadernoName", "modifiedById" ], "type": [ "object", "null" ] } }, "required": [ "note" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upsert tracked case note", "tags": [ "PJUD causas" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/case-tracking/queries/get-cause-breakdown": { "post": { "description": "Get causa breakdown\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-get-cause-breakdown", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "byTeam": [ { "id": "string", "name": "string", "count": 0 } ], "byResponsibleAttorney": [ { "id": "string", "name": "string", "count": 0 } ], "untaggedCount": 0, "unassignedCount": 0, "canViewAllTeams": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "byResponsibleAttorney": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name", "count" ], "type": "object" }, "type": "array" }, "byTeam": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name", "count" ], "type": "object" }, "type": "array" }, "canViewAllTeams": { "type": "boolean" }, "unassignedCount": { "type": "integer" }, "untaggedCount": { "type": "integer" } }, "required": [ "byTeam", "byResponsibleAttorney", "untaggedCount", "unassignedCount", "canViewAllTeams" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get causa breakdown", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/case-tracking/queries/get-cause-lineage": { "post": { "description": "Related causas (origin, exhortos, appeals) of one causa. args[0]: {caseId}.\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-get-cause-lineage", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "\u003cCASE_ID\u003e" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "entries": [ { "causaId": "string", "rol": "string", "competence": "string", "tribunal": "string", "caratulado": "string", "kind": "string", "direction": "string", "depth": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "entries": { "description": "Entries.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "depth": { "type": "integer" }, "direction": { "description": "\"ancestor\" | \"descendant\"", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "causaId", "rol", "competence", "tribunal", "caratulado", "kind", "direction", "depth" ], "type": "object" }, "type": "array" } }, "required": [ "entries" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get causa lineage", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/case-tracking/queries/get-total-active-tracked-cases-count": { "post": { "description": "Count the organization's active tracked causas.\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-get-total-active-tracked-cases-count", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "total": 0 }, "schema": { "properties": { "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "total" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get total active tracked cases count", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/case-tracking/queries/get-tracked-case-detail": { "post": { "description": "Causa detail: metadata, cuadernos (notebooks) with counts, allowed sections, receptor notifications, audios and linked internal cases. args[0]: {caseId} (id or rol). Only causas your organization tracks.\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-get-tracked-case-detail", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "\u003cCASE_ID\u003e" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "trackedCase": { "aiAccessEnabled": true, "aiAccessOrgEnabled": true, "boletinConcursal": { "id": "string", "documentId": "string", "source": "L", "product": "liquidador", "estado": "string", "tipoProcedimiento": "string", "liquidador": "string", "publications": 0 }, "id": "string", "identifier": "string", "matchedByID": true, "rol": "string", "caratulado": "string", "competence": "string", "active": true, "archived": true, "isPrivate": true, "corteId": 0, "tribunalId": 0, "orgIds": [ "string" ], "teamIds": [ "string" ], "clients": [ { "clientId": "string", "accessGranted": true, "lastCheck": "2026-01-31T12:00:00Z" } ], "suspendedOrgs": [ { "orgId": "string", "oId": "string", "addedAt": "2026-01-31T12:00:00Z", "suspendedAt": "2026-01-31T12:00:00Z", "archivedAt": "2026-01-31T12:00:00Z", "archivedReason": "string", "archivedById": "string" } ], "createdAt": "string", "fechaIng": "2026-01-31T12:00:00Z", "lastUpdate": "2026-01-31T12:00:00Z", "successValidUntil": "2026-01-31T12:00:00Z", "status": "string", "errorCategory": "string", "textErrorDesc": "string", "daysWithNoChanges": 0, "lastChangeAt": "string", "latestMovementSummary": "string", "avgResolutionDays": 0, "lastResolutionAt": "2026-01-31T12:00:00Z", "notebooks": [ { "id": "string", "index": 0, "order": 0, "name": "string", "defaultSection": "string", "historyCount": 0, "notificationCount": 0, "pendingCount": 0, "diligenceCount": 0, "relationCount": 0, "audioCount": 0 } ], "defaultNotebook": 0, "notebookTotals": { "historyCount": 0, "notificationCount": 0, "pendingCount": 0, "diligenceCount": 0, "relationCount": 0, "audioCount": 0 }, "allNotebooksIndex": 0, "allowedSections": [ "string" ], "receiverNotifications": [ { "id": "string", "index": 0, "cuaderno": "string", "datosDelRetiro": "string", "fechaRetiro": "string", "estado": "string", "createdAt": "string", "notes": [ { "id": "string", "text": "string", "itemDesc": "string", "orgId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "historiaId": "string", "litiganteId": "string", "exhortoId": "string", "notificacionId": "string", "diligenciaId": "string", "relacionCausaId": "string", "escritoPorResolverId": "string", "plazoId": "string", "audioId": "string", "notificacionReceptorId": "string", "anexoRef": "string" } ] } ], "receiverNotificationsLen": 0, "audios": [ { "id": "string", "numero": 0, "audio": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "notebook": 0, "createdAt": "string", "notes": [ { "id": "string", "text": "string", "itemDesc": "string", "orgId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "historiaId": "string", "litiganteId": "string", "exhortoId": "string", "notificacionId": "string", "diligenciaId": "string", "relacionCausaId": "string", "escritoPorResolverId": "string", "plazoId": "string", "audioId": "string", "notificacionReceptorId": "string", "anexoRef": "string" } ] } ], "audiosLen": 0, "linkedInternalCases": [ { "id": "string", "rol": "string", "caratulado": "string", "currentStateSlug": "string", "archived": true, "updatedAt": "2026-01-31T12:00:00Z", "fechaDeIng": "2026-01-31T12:00:00Z", "orgId": "string" } ], "linkedInternalCasesCount": 0, "basicInfo": { "rol": "string", "caratulado": "string", "competence": "string", "fechaIng": "2026-01-31T12:00:00Z", "corteId": 0, "tribunalId": 0, "tipoProcedimiento": "string", "ruc": "string", "formaDeInicio": "string", "relator": "string", "juezAsignado": "string", "tituloEjecutivo": "string", "certEnvioId": "string", "ebookId": "string", "estadosAdmin": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "estadosProcesal": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "etapas": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "ubicaciones": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "materias": [ { "codigo": "string", "glosa": "string", "estado": "string", "fechaTermino": "2026-01-31T12:00:00Z" } ], "textoDemandas": [ { "index": 0, "doc": "string", "source": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string" } ], "anexos": [ { "index": 0, "doc": "string", "source": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "tramite": "string", "codigo": "string", "cantidad": 0, "tipoDoc": "string", "rut": "string", "nombre": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string" } ], "docsCausa": [ { "index": 0, "doc": "string", "source": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string" } ], "attachments": [ { "index": 0, "doc": "string", "source": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string", "tramite": "string", "codigo": "string", "cantidad": 0, "tipoDoc": "string", "rut": "string", "nombre": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string" } ], "observation": [ { "field": "string", "value": "string" } ], "notebookCount": 0, "litigantCount": 0, "exhortCount": 0, "deadlineCount": 0 }, "upcomingHearings": [ { "startsAt": "2026-01-31T12:00:00Z", "kind": "string", "allDay": true, "source": "string" } ] } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "trackedCase": { "description": "The tracked causa.", "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "aiAccessEnabled": { "description": "Whether AI features may read this causa.", "type": "boolean" }, "aiAccessOrgEnabled": { "description": "Whether the organization allows AI features.", "type": "boolean" }, "allNotebooksIndex": { "type": "integer" }, "allowedSections": { "items": { "type": "string" }, "type": "array" }, "archived": { "description": "Whether the record is archived.", "type": "boolean" }, "audios": { "items": { "properties": { "audio": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "notebook": { "description": "Cuaderno (case-file notebook) index.", "type": "integer" }, "notes": { "description": "This organization's notes on the row, newest first.", "items": { "properties": { "anexoRef": { "description": "Document token of the annotated anexo.", "type": [ "string", "null" ] }, "audioId": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "diligenciaId": { "type": [ "string", "null" ] }, "escritoPorResolverId": { "type": [ "string", "null" ] }, "exhortoId": { "type": [ "string", "null" ] }, "historiaId": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "itemDesc": { "description": "Label of the annotated item, as shown when the note was written.", "type": "string" }, "litiganteId": { "type": [ "string", "null" ] }, "notificacionId": { "type": [ "string", "null" ] }, "notificacionReceptorId": { "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "plazoId": { "type": [ "string", "null" ] }, "relacionCausaId": { "type": [ "string", "null" ] }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "itemDesc", "orgId", "createdAt", "updatedAt", "historiaId", "litiganteId", "exhortoId", "notificacionId", "diligenciaId", "relacionCausaId", "escritoPorResolverId", "plazoId", "audioId", "notificacionReceptorId", "anexoRef" ], "type": "object" }, "type": "array" }, "numero": { "description": "Number.", "type": "integer" }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "id", "numero", "audio", "fecha", "referencia", "notebook", "createdAt", "notes" ], "type": "object" }, "type": "array" }, "audiosLen": { "type": "integer" }, "avgResolutionDays": { "description": "Average days between filings and resolutions.", "type": "number" }, "basicInfo": { "properties": { "anexos": { "description": "Attachments.", "items": { "properties": { "cantidad": { "type": [ "number", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "doc": { "description": "Document token; pass it as path to get-tracked-case-document-url.", "type": "string" }, "docFisico": { "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "estadoFirma": { "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "source": { "description": "Which list the anexo comes from (attachment, history-attachment, pending-filing-attachment, liquidation-attachment).", "type": "string" }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] } }, "required": [ "index", "doc", "source", "fecha", "referencia", "tramite", "codigo", "cantidad", "tipoDoc", "rut", "nombre", "docFisico", "doctoFisico", "estadoFirma", "tipoLit" ], "type": "object" }, "type": "array" }, "attachments": { "description": "Claim texts (source claim-text), anexos (attachment) and cause documents (cause-document); pieza only on claim texts and cause documents, tramite..tipoLit only on anexos.", "items": { "properties": { "cantidad": { "type": [ "number", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "doc": { "description": "Document token; pass it as path to get-tracked-case-document-url.", "type": "string" }, "docFisico": { "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "estadoFirma": { "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "source": { "description": "Which list the document comes from (claim-text, cause-document, exhort-document...).", "type": "string" }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "certEnvioId": { "description": "PJUD certificate-of-filing id.", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "deadlineCount": { "type": "integer" }, "docsCausa": { "items": { "properties": { "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "type": "string" } }, "required": [ "index", "doc", "source", "fecha", "referencia", "pieza" ], "type": "object" }, "type": "array" }, "ebookId": { "type": [ "string", "null" ] }, "estadosAdmin": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "estadosProcesal": { "description": "Procedural statuses.", "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "etapas": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "exhortCount": { "type": "integer" }, "fechaIng": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "formaDeInicio": { "type": [ "string", "null" ] }, "juezAsignado": { "type": [ "string", "null" ] }, "litigantCount": { "type": "integer" }, "materias": { "items": { "properties": { "codigo": { "description": "Short code.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaTermino": { "description": "End date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "glosa": { "description": "Description as PJUD words it.", "type": "string" } }, "required": [ "codigo", "glosa", "estado", "fechaTermino" ], "type": "object" }, "type": "array" }, "notebookCount": { "type": "integer" }, "observation": { "description": "Suprema observations, one row per key, sorted by key.", "items": { "properties": { "field": { "description": "Observation key (raw, relatorAsignado).", "type": "string" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "field", "value" ], "type": "object" }, "type": "array" }, "relator": { "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": [ "string", "null" ] }, "textoDemandas": { "items": { "properties": { "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "type": "string" } }, "required": [ "index", "doc", "source", "fecha", "referencia", "pieza" ], "type": "object" }, "type": "array" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" }, "tituloEjecutivo": { "type": [ "string", "null" ] }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] }, "ubicaciones": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" } }, "required": [ "rol", "caratulado", "competence", "fechaIng", "corteId", "tribunalId", "tipoProcedimiento", "ruc", "formaDeInicio", "relator", "juezAsignado", "tituloEjecutivo", "certEnvioId", "ebookId", "estadosAdmin", "estadosProcesal", "etapas", "ubicaciones", "materias", "textoDemandas", "anexos", "docsCausa", "attachments", "observation", "notebookCount", "litigantCount", "exhortCount", "deadlineCount" ], "type": "object" }, "boletinConcursal": { "description": "The linked Boletín Concursal procedimiento; null when the causa has none.", "properties": { "documentId": { "description": "Boletín Concursal procedimiento id.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "liquidador": { "type": "string" }, "product": { "enum": [ "liquidador", "public" ], "type": "string" }, "publications": { "description": "Publications.", "type": "integer" }, "source": { "description": "L: this org's liquidador portal; P: public registry.", "enum": [ "L", "P" ], "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" } }, "required": [ "id", "documentId", "source", "product", "estado", "tipoProcedimiento", "liquidador", "publications" ], "type": [ "object", "null" ] }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "clients": { "description": "Clients linked to the record.", "items": { "properties": { "accessGranted": { "type": "boolean" }, "clientId": { "description": "Client id.", "type": "string" }, "lastCheck": { "description": "Last time access was checked (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "clientId", "accessGranted" ], "type": "object" }, "type": "array" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "type": "string" }, "daysWithNoChanges": { "description": "Days since PJUD last showed a change.", "type": "integer" }, "defaultNotebook": { "type": "integer" }, "errorCategory": { "description": "Category of the last scraping error.", "type": "string" }, "fechaIng": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "identifier": { "description": "Causa identifier as PJUD shows it.", "type": "string" }, "isPrivate": { "description": "Whether only its members can see it.", "type": "boolean" }, "lastChangeAt": { "description": "When PJUD last showed a change (ISO 8601).", "type": "string" }, "lastResolutionAt": { "description": "Date of the latest resolution (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "lastUpdate": { "description": "Last time the causa was refreshed from PJUD (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "latestMovementSummary": { "description": "Summary of the newest movement.", "type": "string" }, "linkedInternalCases": { "items": { "properties": { "archived": { "description": "Whether the record is archived.", "type": "boolean" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "currentStateSlug": { "description": "Slug of the current workflow state.", "type": [ "string", "null" ] }, "fechaDeIng": { "description": "Filing date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "rol", "caratulado", "currentStateSlug", "archived", "updatedAt", "fechaDeIng", "orgId" ], "type": "object" }, "type": "array" }, "linkedInternalCasesCount": { "type": "integer" }, "matchedByID": { "description": "Whether the causa was found by id rather than by rol.", "type": "boolean" }, "notebookTotals": { "description": "Row counts summed over every cuaderno.", "properties": { "audioCount": { "type": "integer" }, "diligenceCount": { "type": "integer" }, "historyCount": { "description": "Number of movements.", "type": "integer" }, "notificationCount": { "description": "Number of notifications.", "type": "integer" }, "pendingCount": { "description": "Number of pending writs.", "type": "integer" }, "relationCount": { "type": "integer" } }, "required": [ "historyCount", "notificationCount", "pendingCount", "diligenceCount", "relationCount", "audioCount" ], "type": "object" }, "notebooks": { "description": "Cuadernos (case-file notebooks).", "items": { "properties": { "audioCount": { "type": "integer" }, "defaultSection": { "description": "Section opened by default.", "type": "string" }, "diligenceCount": { "type": "integer" }, "historyCount": { "description": "Number of movements.", "type": "integer" }, "id": { "description": "Unique identifier.", "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "name": { "description": "Display name.", "type": "string" }, "notificationCount": { "description": "Number of notifications.", "type": "integer" }, "order": { "description": "Sort position.", "type": "integer" }, "pendingCount": { "description": "Number of pending writs.", "type": "integer" }, "relationCount": { "type": "integer" } }, "required": [ "id", "index", "order", "name", "defaultSection", "historyCount", "notificationCount", "pendingCount", "diligenceCount", "relationCount", "audioCount" ], "type": "object" }, "type": "array" }, "orgIds": { "description": "Ids of the organizations that can see it.", "items": { "type": "string" }, "type": "array" }, "receiverNotifications": { "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "type": "string" }, "cuaderno": { "description": "Cuaderno (case-file notebook).", "type": "string" }, "datosDelRetiro": { "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaRetiro": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "notes": { "description": "This organization's notes on the row, newest first.", "items": { "properties": { "anexoRef": { "description": "Document token of the annotated anexo.", "type": [ "string", "null" ] }, "audioId": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "diligenciaId": { "type": [ "string", "null" ] }, "escritoPorResolverId": { "type": [ "string", "null" ] }, "exhortoId": { "type": [ "string", "null" ] }, "historiaId": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "itemDesc": { "description": "Label of the annotated item, as shown when the note was written.", "type": "string" }, "litiganteId": { "type": [ "string", "null" ] }, "notificacionId": { "type": [ "string", "null" ] }, "notificacionReceptorId": { "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "plazoId": { "type": [ "string", "null" ] }, "relacionCausaId": { "type": [ "string", "null" ] }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "itemDesc", "orgId", "createdAt", "updatedAt", "historiaId", "litiganteId", "exhortoId", "notificacionId", "diligenciaId", "relacionCausaId", "escritoPorResolverId", "plazoId", "audioId", "notificacionReceptorId", "anexoRef" ], "type": "object" }, "type": "array" } }, "required": [ "id", "index", "cuaderno", "datosDelRetiro", "fechaRetiro", "estado", "createdAt", "notes" ], "type": "object" }, "type": "array" }, "receiverNotificationsLen": { "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "successValidUntil": { "description": "Until when the last successful refresh is considered current (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "suspendedOrgs": { "description": "Per-organization tracking state of the causa, for every organization that tracks it.", "items": { "properties": { "addedAt": { "format": "date-time", "type": [ "string", "null" ] }, "archivedAt": { "format": "date-time", "type": [ "string", "null" ] }, "archivedById": { "type": [ "string", "null" ] }, "archivedReason": { "description": "manual, bulk or bc-estado.", "type": [ "string", "null" ] }, "oId": { "description": "Legacy spelling of orgId.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "suspendedAt": { "description": "Set while this org's tracking is suspended.", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "teamIds": { "description": "Ids of the teams it is assigned to.", "items": { "type": "string" }, "type": "array" }, "textErrorDesc": { "description": "Detail of the last scraping error.", "type": [ "string", "null" ] }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] }, "upcomingHearings": { "description": "Up to 10 hearings from today on (Chile time).", "items": { "properties": { "allDay": { "type": "boolean" }, "kind": { "description": "Hearing type (PREPARATORIA, JUICIO, CONCILIACION...).", "type": "string" }, "source": { "description": "How the hearing was found (DETERMINISTIC wins over other sources for the same time).", "type": "string" }, "startsAt": { "format": "date-time", "type": "string" } }, "required": [ "startsAt", "kind", "allDay", "source" ], "type": "object" }, "type": "array" } }, "required": [ "aiAccessEnabled", "aiAccessOrgEnabled", "boletinConcursal", "id", "identifier", "matchedByID", "rol", "caratulado", "competence", "active", "archived", "isPrivate", "corteId", "tribunalId", "orgIds", "teamIds", "clients", "suspendedOrgs", "createdAt", "fechaIng", "lastUpdate", "successValidUntil", "status", "errorCategory", "textErrorDesc", "daysWithNoChanges", "lastChangeAt", "latestMovementSummary", "avgResolutionDays", "lastResolutionAt", "notebooks", "defaultNotebook", "notebookTotals", "allNotebooksIndex", "allowedSections", "receiverNotifications", "receiverNotificationsLen", "audios", "audiosLen", "linkedInternalCases", "linkedInternalCasesCount", "basicInfo", "upcomingHearings" ], "type": "object" } }, "required": [ "trackedCase" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tracked case detail", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/case-tracking/queries/get-tracked-case-document-url": { "post": { "description": "Signed download URL for a causa document or anexo. args[0]: {caseId, path} with path taken from a section row.\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-get-tracked-case-document-url", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "\u003cCASE_ID\u003e", "path": "\u003cDOCUMENT_PATH\u003e" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "recoveryQueued": true, "url": "string", "previewUrl": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "previewUrl": { "description": "Short-lived URL to preview the file.", "type": "string" }, "recoveryQueued": { "description": "Whether a recovery job was queued.", "type": "boolean" }, "url": { "description": "Absolute URL.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tracked case document url", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/case-tracking/queries/get-tracked-case-section": { "post": { "description": "One section of a causa, paged: default (movimientos), litigants, notifications, pending-filings, exhorts, attachments (anexos), diligences, deadlines, ... args[0]: {caseId, notebook (-1 = all cuadernos), section, page, per_page, sort, search, from, to}.\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-get-tracked-case-section", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "\u003cCASE_ID\u003e", "notebook": -1, "page": 1, "per_page": 50, "section": "default" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" }, "filters": { "type": "object" }, "from": { "type": "string" }, "notebook": { "type": "number" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "search": { "type": "string" }, "section": { "type": "string" }, "sort": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "section": { "slug": "string", "notebook": 0, "allNotebooks": true, "total": 0, "pageCount": 0, "rows": [ { "estado": {}, "doc": "string", "rol": "string", "nombre": "string", "tramite": "string", "codigo": "string", "fechaTermino": "2026-01-31T12:00:00Z", "fechaTramite": "2026-01-31T12:00:00Z", "id": "string", "order": 0, "folio": "string", "nulo": true, "reposicion": true, "mismoFolio": 0, "especial": true, "sala": "string", "certEnvioId": "string", "georref": { "latitud": 0, "longitud": 0, "lat": 0, "lng": 0, "corrector": 0 }, "anexoCount": 0, "anexos": [ { "index": 0, "doc": "string", "source": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "tramite": "string", "codigo": "string", "cantidad": 0, "tipoDoc": "string", "rut": "string", "nombre": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string", "notes": [ { "id": "string", "text": "string", "itemDesc": "string", "orgId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "historiaId": "string", "litiganteId": "string", "exhortoId": "string", "notificacionId": "string", "diligenciaId": "string", "relacionCausaId": "string", "escritoPorResolverId": "string", "plazoId": "string", "audioId": "string", "notificacionReceptorId": "string", "anexoRef": "string" } ] } ], "anexoType": "string", "etapa": "string", "descTramite": "string", "segundaFechaTramite": "2026-01-31T12:00:00Z", "fechaRecepcion": "2026-01-31T12:00:00Z", "foja": "string", "conAudios": true, "rut": "string", "monto": 0, "cuadernoLiq": "string", "allDocsOk": true, "createdAt": "2026-01-31T12:00:00Z", "notes": [ { "id": "string", "text": "string", "itemDesc": "string", "orgId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "historiaId": "string", "litiganteId": "string", "exhortoId": "string", "notificacionId": "string", "diligenciaId": "string", "relacionCausaId": "string", "escritoPorResolverId": "string", "plazoId": "string", "audioId": "string", "notificacionReceptorId": "string", "anexoRef": "string" } ], "participante": "string", "persona": "string", "abogadoDefensor": true, "index": 0, "estadoNotif": "string", "tipoNotif": "string", "fechaAudiencia": "2026-01-31T12:00:00Z", "tipoPart": "string", "obsFallida": "string", "ruc": "string", "enteNotificador": "string", "notificationDetail": [ { "idx": 0, "codigo": "string", "fecha": "2026-01-31T12:00:00Z", "tipo": "string", "observación": "string" } ], "fechaIngreso": "2026-01-31T12:00:00Z", "tipo": "string", "solicitante": "string", "referencia": "string", "indexPorFecha": 0, "rolOrigen": "string", "tipoExhorto": "string", "documentCount": 0, "documentosExhortos": [ { "index": 0, "doc": "string", "source": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string" } ], "fechaOrdenaExhorto": "2026-01-31T12:00:00Z", "fechaIngresaExhorto": "2026-01-31T12:00:00Z", "rolDestino": "string", "tribunalDestino": 0, "estadoExhorto": "string", "tribunalOrigen": "string", "delito": "string", "fechaCambioEstado": "2026-01-31T12:00:00Z", "docIda": "string", "docVta": "string", "hasDocuments": true, "rit": "string", "tipoDiligencia": "string", "destinatario": "string", "responsable": "string", "fecha": "2026-01-31T12:00:00Z", "glosa": "string", "tipoPlazo": "string", "ambitoAfectado": "string", "fechaInicio": "2026-01-31T12:00:00Z", "duracion": "string", "fechaSuspencion": "2026-01-31T12:00:00Z", "fechaReactivacion": "2026-01-31T12:00:00Z", "prestacion": "string", "fechaPrestacion": "2026-01-31T12:00:00Z", "fechaActualizar": "2026-01-31T12:00:00Z", "saldoDeuda": 0, "fechaLiq": "2026-01-31T12:00:00Z", "porcentajeReajuste": 0, "porcentajeInteres": 0, "source": "string", "pieza": "string", "cantidad": 0, "tipoDoc": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string", "field": "string", "value": "string", "tribunalId": 0, "title": "string", "content": "string", "orgId": "string", "updatedAt": "2026-01-31T12:00:00Z", "caratulado": "string", "currentStateSlug": "string", "archived": true, "fechaDeIng": "2026-01-31T12:00:00Z", "notebook": 0, "notebookName": "string" } ], "defaultSort": "string", "defaultSortDesc": true, "availableSections": [ "string" ] } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "section": { "description": "The requested section.", "properties": { "allNotebooks": { "type": "boolean" }, "availableSections": { "items": { "type": "string" }, "type": "array" }, "defaultSort": { "type": "string" }, "defaultSortDesc": { "type": "boolean" }, "notebook": { "description": "Cuaderno (case-file notebook) index.", "type": "integer" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "rows": { "description": "The page's rows; their shape depends on slug (default = movimientos, litigants, notifications, pending-filings, exhorts, relations, diligences, subjects, deadlines, liquidations, current-debt, attachments, observation, incompetence, bitacoras, internal-cases), so every key is optional.", "items": { "properties": { "abogadoDefensor": { "description": "Defense attorney.", "type": [ "boolean", "null" ] }, "allDocsOk": { "description": "Every document of the row has been downloaded.", "type": "boolean" }, "ambitoAfectado": { "description": "Scope the deadline affects.", "type": "string" }, "anexoCount": { "description": "Number of attachments.", "type": "integer" }, "anexoType": { "description": "Attachment type.", "type": [ "string", "null" ] }, "anexos": { "description": "Attachments.", "items": { "properties": { "cantidad": { "type": [ "number", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "doc": { "description": "Document token; pass it as path to get-tracked-case-document-url.", "type": "string" }, "docFisico": { "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "estadoFirma": { "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "notes": { "description": "This organization's notes on the row, newest first.", "items": { "properties": { "anexoRef": { "description": "Document token of the annotated anexo.", "type": [ "string", "null" ] }, "audioId": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "diligenciaId": { "type": [ "string", "null" ] }, "escritoPorResolverId": { "type": [ "string", "null" ] }, "exhortoId": { "type": [ "string", "null" ] }, "historiaId": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "itemDesc": { "description": "Label of the annotated item, as shown when the note was written.", "type": "string" }, "litiganteId": { "type": [ "string", "null" ] }, "notificacionId": { "type": [ "string", "null" ] }, "notificacionReceptorId": { "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "plazoId": { "type": [ "string", "null" ] }, "relacionCausaId": { "type": [ "string", "null" ] }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "itemDesc", "orgId", "createdAt", "updatedAt", "historiaId", "litiganteId", "exhortoId", "notificacionId", "diligenciaId", "relacionCausaId", "escritoPorResolverId", "plazoId", "audioId", "notificacionReceptorId", "anexoRef" ], "type": "object" }, "type": "array" }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "source": { "description": "Which list the anexo comes from (attachment, history-attachment, pending-filing-attachment, liquidation-attachment).", "type": "string" }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] } }, "required": [ "index", "doc", "source", "fecha", "referencia", "tramite", "codigo", "cantidad", "tipoDoc", "rut", "nombre", "docFisico", "doctoFisico", "estadoFirma", "tipoLit", "notes" ], "type": "object" }, "type": "array" }, "archived": { "description": "Whether the record is archived.", "type": "boolean" }, "cantidad": { "type": [ "number", "null" ] }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "certEnvioId": { "description": "PJUD certificate-of-filing id.", "type": [ "string", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "conAudios": { "description": "Whether hearing audio is attached.", "type": [ "boolean", "null" ] }, "content": { "description": "Content.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "cuadernoLiq": { "description": "Liquidation notebook the entry belongs to.", "type": [ "string", "null" ] }, "currentStateSlug": { "description": "Slug of the current workflow state.", "type": [ "string", "null" ] }, "delito": { "description": "Offense (penal causas).", "type": "string" }, "descTramite": { "description": "Description of the procedural step.", "type": "string" }, "destinatario": { "description": "Recipient.", "type": [ "string", "null" ] }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": [ "string", "null" ] }, "docFisico": { "type": [ "string", "null" ] }, "docIda": { "description": "Outgoing document of the exhorto.", "type": [ "string", "null" ] }, "docVta": { "description": "Returned document of the exhorto.", "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "documentCount": { "description": "Number of documents.", "type": "integer" }, "documentosExhortos": { "description": "Documents of the exhorto.", "items": { "properties": { "doc": { "description": "Document token; pass it as path to get-tracked-case-document-url.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "source": { "description": "Which list the document comes from (claim-text, cause-document, exhort-document...).", "type": "string" } }, "required": [ "index", "doc", "source", "fecha", "referencia", "pieza" ], "type": "object" }, "type": "array" }, "duracion": { "description": "Duration.", "type": "string" }, "enteNotificador": { "description": "Who served the notification.", "type": [ "string", "null" ] }, "especial": { "description": "Whether PJUD flags the entry as special.", "type": "boolean" }, "estado": { "description": "State text for most sections; a boolean (or null) for litigants; null when unknown." }, "estadoExhorto": { "description": "Exhorto status.", "type": "string" }, "estadoFirma": { "type": [ "string", "null" ] }, "estadoNotif": { "description": "Notification status.", "type": "string" }, "etapa": { "description": "Procedural stage.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaActualizar": { "description": "Date the amount was last updated (ISO 8601).", "format": "date-time", "type": "string" }, "fechaAudiencia": { "description": "Hearing date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaCambioEstado": { "description": "Date of the last status change (ISO 8601).", "format": "date-time", "type": "string" }, "fechaDeIng": { "description": "Filing date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaIngresaExhorto": { "description": "Date the exhorto was filed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaIngreso": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": "string" }, "fechaInicio": { "description": "Start date (ISO 8601).", "format": "date-time", "type": "string" }, "fechaLiq": { "description": "Settlement date (ISO 8601).", "format": "date-time", "type": "string" }, "fechaOrdenaExhorto": { "description": "Date the exhorto was ordered (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaPrestacion": { "description": "Date of the claimed benefit (ISO 8601).", "format": "date-time", "type": "string" }, "fechaReactivacion": { "description": "Date reactivated (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaRecepcion": { "description": "Date received (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaSuspencion": { "description": "Date suspended (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaTermino": { "description": "End date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaTramite": { "description": "Date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "field": { "description": "Observation key (raw, relatorAsignado).", "type": "string" }, "foja": { "description": "Foja (page number in the court file).", "type": [ "string", "null" ] }, "folio": { "description": "Folio number in the court file.", "type": "string" }, "georref": { "description": "Georeference PJUD attaches to the entry.", "properties": { "corrector": { "description": "Correction value, when PJUD sends one.", "type": "number" }, "lat": { "description": "Alias of latitud.", "type": "number" }, "latitud": { "description": "Latitude; kept as the portal's string if it is not numeric.", "type": "number" }, "lng": { "description": "Alias of longitud.", "type": "number" }, "longitud": { "description": "Longitude; kept as the portal's string if it is not numeric.", "type": "number" } }, "required": [ "latitud", "longitud", "lat", "lng" ], "type": [ "object", "null" ] }, "glosa": { "description": "Description as PJUD words it.", "type": "string" }, "hasDocuments": { "description": "Whether documents are attached.", "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "indexPorFecha": { "description": "Position among the entries of the same date.", "type": "integer" }, "mismoFolio": { "description": "Occurrence number among movements sharing the folio.", "type": "integer" }, "monto": { "description": "Amount in Chilean pesos.", "type": [ "integer", "null" ] }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "notebook": { "description": "Cuaderno index the row belongs to; only when every cuaderno was requested (notebook -1).", "type": "integer" }, "notebookName": { "description": "Cuaderno name; only when every cuaderno was requested.", "type": "string" }, "notes": { "description": "This organization's notes on the row, newest first.", "items": { "properties": { "anexoRef": { "description": "Document token of the annotated anexo.", "type": [ "string", "null" ] }, "audioId": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "diligenciaId": { "type": [ "string", "null" ] }, "escritoPorResolverId": { "type": [ "string", "null" ] }, "exhortoId": { "type": [ "string", "null" ] }, "historiaId": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "itemDesc": { "description": "Label of the annotated item, as shown when the note was written.", "type": "string" }, "litiganteId": { "type": [ "string", "null" ] }, "notificacionId": { "type": [ "string", "null" ] }, "notificacionReceptorId": { "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "plazoId": { "type": [ "string", "null" ] }, "relacionCausaId": { "type": [ "string", "null" ] }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "itemDesc", "orgId", "createdAt", "updatedAt", "historiaId", "litiganteId", "exhortoId", "notificacionId", "diligenciaId", "relacionCausaId", "escritoPorResolverId", "plazoId", "audioId", "notificacionReceptorId", "anexoRef" ], "type": "object" }, "type": "array" }, "notificationDetail": { "description": "Notification detail.", "items": { "properties": { "codigo": { "description": "Short code.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "idx": { "description": "Row position.", "type": "integer" }, "observación": { "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "idx", "codigo", "fecha", "tipo", "observación" ], "type": "object" }, "type": "array" }, "nulo": { "description": "Whether PJUD marks the entry as void.", "type": "boolean" }, "obsFallida": { "description": "Note on why the notification failed.", "type": [ "string", "null" ] }, "order": { "description": "Sort position.", "type": [ "integer", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "participante": { "description": "Parties to the causa.", "type": [ "string", "null" ] }, "persona": { "description": "Party name.", "type": "string" }, "pieza": { "type": [ "string", "null" ] }, "porcentajeInteres": { "description": "Interest percentage.", "type": "number" }, "porcentajeReajuste": { "description": "Inflation adjustment percentage.", "type": "number" }, "prestacion": { "description": "Claimed benefit or payment.", "type": "string" }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "reposicion": { "description": "Whether the entry is a motion for reconsideration.", "type": "boolean" }, "responsable": { "description": "Person responsible.", "type": [ "string", "null" ] }, "rit": { "description": "Causa RIT, for courts that number by RIT.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "rolDestino": { "description": "Rol at the receiving court.", "type": "string" }, "rolOrigen": { "description": "Rol at the originating court.", "type": [ "string", "null" ] }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "sala": { "description": "Court chamber (sala).", "type": [ "string", "null" ] }, "saldoDeuda": { "description": "Outstanding debt balance in Chilean pesos.", "type": "number" }, "segundaFechaTramite": { "description": "Second date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "solicitante": { "description": "Who made the request.", "type": "string" }, "source": { "description": "Which list the document comes from (claim-text, cause-document, exhort-document...).", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "tipoDiligencia": { "description": "Type of court proceeding.", "type": "string" }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoExhorto": { "description": "Exhorto (letter rogatory) type.", "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tipoNotif": { "description": "Notification type.", "type": [ "string", "null" ] }, "tipoPart": { "description": "Party role in the causa.", "type": "string" }, "tipoPlazo": { "description": "Deadline type.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] }, "tribunalDestino": { "description": "Court the case went to.", "type": "integer" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" }, "tribunalOrigen": { "description": "Court the case came from.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "value": { "description": "Value.", "type": "string" } }, "type": "object" }, "type": "array" }, "slug": { "description": "URL-safe identifier.", "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "slug", "notebook", "allNotebooks", "total", "pageCount", "rows", "defaultSort", "defaultSortDesc", "availableSections" ], "type": "object" } }, "required": [ "section" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tracked case section", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/case-tracking/queries/get-tracked-cases": { "post": { "description": "List the organization's tracked causas (filters and pagination in args[0]).\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-get-tracked-cases", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caratulado": "", "page": 1, "per_page": 25, "rol": "", "sort": "updatedAt.desc" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "archived": { "type": "string" }, "assigneeRole": { "type": "string" }, "assigneeUserId": { "type": "string" }, "boletinConcursal": { "type": "string" }, "caratulado": { "type": "string" }, "changedWithinDays": { "type": "string" }, "clientIds": { "type": "string" }, "competence": { "type": "string" }, "corteId": { "type": "string" }, "createdWithinDays": { "type": "string" }, "folio": { "type": "string" }, "from": { "type": "string" }, "hideAutoRelated": { "type": "string" }, "noClient": { "type": "string" }, "nombre": { "type": "string" }, "operator": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "rol": { "type": "string" }, "sort": { "type": "string" }, "suspendedOrgs": { "type": "string" }, "teamId": { "type": "string" }, "to": { "type": "string" }, "tramite": { "type": "string" }, "tribunalId": { "type": "string" }, "unassigned": { "type": "string" }, "unchangedForDays": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causes": [ { "id": "string", "createdAt": "2026-01-31T12:00:00Z", "rol": "string", "caratulado": "string", "competence": "SUPREMA", "corteId": 0, "tribunalId": 0, "active": true, "archived": true, "archivedAt": "2026-01-31T12:00:00Z", "isPrivate": true, "status": "SUCCESS", "fechaIng": "2026-01-31T12:00:00Z", "lastUpdate": "2026-01-31T12:00:00Z", "lastChangeAt": "2026-01-31T12:00:00Z", "daysWithNoChanges": 0, "successValidUntil": "2026-01-31T12:00:00Z", "errorCategory": "OTHER", "textErrorDesc": "string", "orgIds": [ "string" ], "teamIds": [ "string" ], "clients": [ { "clientId": "string", "cId": "string", "orgId": "string", "oId": "string", "accessGranted": true, "aG": true, "lastCheck": "2026-01-31T12:00:00Z", "lc": "2026-01-31T12:00:00Z" } ], "suspendedOrgs": [ { "orgId": "string", "oId": "string", "addedAt": "2026-01-31T12:00:00Z", "suspendedAt": "2026-01-31T12:00:00Z", "archivedAt": "2026-01-31T12:00:00Z", "archivedReason": "string", "archivedById": "string" } ], "estadosProcesal": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "cuadernoCount": 0, "autoTracked": true, "relation": { "kind": "string", "parentRol": "string", "parentCausaId": "string" } } ], "pageCount": 0, "total": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causes": { "description": "Causas.", "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "archived": { "description": "Whether the record is archived.", "type": "boolean" }, "archivedAt": { "format": "date-time", "type": [ "string", "null" ] }, "autoTracked": { "description": "Whether Nexulex started tracking it automatically (e.g. an exhorto of a tracked causa).", "type": "boolean" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "clients": { "description": "Client credentials linked to the causa, as stored (long keys and their compact aliases).", "items": { "properties": { "aG": { "description": "Compact alias of accessGranted.", "type": "boolean" }, "accessGranted": { "type": "boolean" }, "cId": { "description": "Compact alias of clientId.", "type": "string" }, "clientId": { "description": "Client id.", "type": "string" }, "lastCheck": { "description": "Last time access was checked (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "lc": { "description": "Compact alias of lastCheck.", "format": "date-time", "type": [ "string", "null" ] }, "oId": { "description": "Compact alias of orgId.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" } }, "type": "object" }, "type": "array" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "enum": [ "SUPREMA", "APELACIONES", "CIVIL", "LABORAL", "PENAL", "COBRANZA", "FAMILIA" ], "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "cuadernoCount": { "description": "Number of cuadernos (case-file notebooks).", "type": "integer" }, "daysWithNoChanges": { "description": "Days since PJUD last showed a change.", "type": "integer" }, "errorCategory": { "description": "Category of the last scraping error.", "enum": [ "OTHER", "DOWNLOADS", "NO_VALID_CU", "BLOCKED", "TIMEOUT" ], "type": "string" }, "estadosProcesal": { "description": "Estado procesal history, oldest first.", "items": { "properties": { "changedAt": { "description": "When this value was first seen.", "format": "date-time", "type": "string" }, "counter": { "description": "How many times this value has been seen in a row.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "fechaIng": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "isPrivate": { "description": "Whether only its members can see it.", "type": "boolean" }, "lastChangeAt": { "description": "When PJUD last showed a change (ISO 8601).", "format": "date-time", "type": "string" }, "lastUpdate": { "description": "Last time the causa was refreshed from PJUD (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "orgIds": { "description": "Ids of the organizations that can see it.", "items": { "type": "string" }, "type": "array" }, "relation": { "description": "How this causa relates to its parent causa; null when it has none.", "properties": { "kind": { "description": "Record subtype.", "type": "string" }, "parentCausaId": { "description": "Id of the parent causa.", "type": "string" }, "parentRol": { "description": "En Laboral, Penal, Cobranza es RIT", "type": "string" } }, "required": [ "kind", "parentRol", "parentCausaId" ], "type": [ "object", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "status": { "description": "Current status.", "enum": [ "SUCCESS", "IN_PROGRESS", "ERROR", "WAITING", "NOT_PRESENT", "PJUD_WITH_ERROR", "APPROVED", "PENDING", "BACKGROUND_CHECK", "WAITING_FOR_DOCUMENTS", "REJECTED" ], "type": "string" }, "successValidUntil": { "description": "Until when the last successful refresh is considered current (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "suspendedOrgs": { "description": "Per-organization tracking state of the causa, for every organization that tracks it.", "items": { "properties": { "addedAt": { "format": "date-time", "type": [ "string", "null" ] }, "archivedAt": { "format": "date-time", "type": [ "string", "null" ] }, "archivedById": { "type": [ "string", "null" ] }, "archivedReason": { "description": "manual, bulk or bc-estado.", "type": [ "string", "null" ] }, "oId": { "description": "Legacy spelling of orgId.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "suspendedAt": { "description": "Set while this org's tracking is suspended.", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "teamIds": { "description": "Ids of the teams it is assigned to.", "items": { "type": "string" }, "type": "array" }, "textErrorDesc": { "description": "Detail of the last scraping error.", "type": [ "string", "null" ] }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "createdAt", "rol", "caratulado", "competence", "corteId", "tribunalId", "active", "archived", "archivedAt", "isPrivate", "status", "fechaIng", "lastUpdate", "lastChangeAt", "daysWithNoChanges", "successValidUntil", "errorCategory", "textErrorDesc", "orgIds", "teamIds", "clients", "suspendedOrgs", "estadosProcesal", "cuadernoCount", "autoTracked", "relation" ], "type": "object" }, "type": "array" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "causes", "pageCount", "total" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tracked cases", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/case-tracking/queries/get-untagged-causes": { "post": { "description": "Get untagged causes\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-get-untagged-causes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "archived": "", "assigneeRole": "", "assigneeUserId": "", "boletinConcursal": "", "caratulado": "", "changedWithinDays": "", "clientIds": "", "competence": "", "corteId": "", "createdWithinDays": "", "folio": "", "from": "", "hideAutoRelated": "", "noClient": "", "nombre": "", "operator": "", "page": 0, "per_page": 0, "rol": "", "sort": "", "suspendedOrgs": "", "teamId": "", "to": "", "tramite": "", "tribunalId": "", "unassigned": "", "unchangedForDays": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "archived": { "type": "string" }, "assigneeRole": { "type": "string" }, "assigneeUserId": { "type": "string" }, "boletinConcursal": { "type": "string" }, "caratulado": { "type": "string" }, "changedWithinDays": { "type": "string" }, "clientIds": { "type": "string" }, "competence": { "type": "string" }, "corteId": { "type": "string" }, "createdWithinDays": { "type": "string" }, "folio": { "type": "string" }, "from": { "type": "string" }, "hideAutoRelated": { "type": "string" }, "noClient": { "type": "string" }, "nombre": { "type": "string" }, "operator": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "rol": { "type": "string" }, "sort": { "type": "string" }, "suspendedOrgs": { "type": "string" }, "teamId": { "type": "string" }, "to": { "type": "string" }, "tramite": { "type": "string" }, "tribunalId": { "type": "string" }, "unassigned": { "type": "string" }, "unchangedForDays": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causes": [ { "id": "string", "rol": "string", "caratulado": "string", "competence": "SUPREMA", "corteId": 0, "tribunalId": 0, "fechaIng": "2026-01-31T12:00:00Z", "lastChangeAt": "2026-01-31T12:00:00Z" } ], "pageCount": 0, "total": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causes": { "description": "Causas.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "enum": [ "SUPREMA", "APELACIONES", "CIVIL", "LABORAL", "PENAL", "COBRANZA", "FAMILIA" ], "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "fechaIng": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "lastChangeAt": { "description": "When PJUD last showed a change (ISO 8601).", "format": "date-time", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "rol", "caratulado", "competence", "corteId", "tribunalId", "fechaIng", "lastChangeAt" ], "type": "object" }, "type": "array" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "causes", "pageCount", "total" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get untagged causes", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/case-tracking/queries/get-untracked-cause-lineage": { "post": { "description": "Get untracked causa lineage\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-get-untracked-cause-lineage", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "entries": [ { "causaId": "string", "rol": "string", "competence": "string", "tribunal": "string", "caratulado": "string", "kind": "string", "sourceInternalCauseId": "string", "sourceInternalCauseName": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "entries": { "description": "Entries.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "sourceInternalCauseId": { "type": "string" }, "sourceInternalCauseName": { "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "causaId", "rol", "competence", "tribunal", "caratulado", "kind", "sourceInternalCauseId", "sourceInternalCauseName" ], "type": "object" }, "type": "array" } }, "required": [ "entries" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get untracked causa lineage", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/case-tracking/queries/list-queued-tracked-case-searches": { "post": { "description": "List queued tracked case searches\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-case-tracking-queries-list-queued-tracked-case-searches", "requestBody": { "content": { "application/json": { "example": { "args": [ { "all": false, "creationKey": "", "internalCaseId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "all": { "type": "boolean" }, "creationKey": { "type": "string" }, "internalCaseId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "id": "string", "label": "string", "state": "string", "attempts": 0, "reason": "string", "createdAt": "string", "causaId": "string", "lastError": "string", "finishedAt": "string", "nextAttemptAt": "string" } ], "openCount": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "items": { "description": "The records returned.", "items": { "properties": { "attempts": { "description": "Number of attempts.", "type": "integer" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "type": "string" }, "finishedAt": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": "string" }, "nextAttemptAt": { "type": "string" }, "reason": { "description": "Why this happened.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "label", "state", "attempts", "reason", "createdAt", "causaId", "lastError" ], "type": "object" }, "type": "array" }, "openCount": { "type": "integer" } }, "required": [ "items" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List queued tracked case searches", "tags": [ "PJUD causas" ], "x-required-scope": "causas:read" } }, "/api/actions/causa-lookup/mutations/fetch-lookup-document": { "post": { "description": "Download one document of a consulta única: args[0] = {lookupId, documentRef}. Returns a signed URL valid for one hour. Billed per document (PJUD_LOOKUP_DOCUMENT); a failed download is not billed. Lookups are kept 7 days.\n\nAuthentication: developer API key. Required scope: `causas:lookup`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-causa-lookup-mutations-fetch-lookup-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "_lookupCaller": { "apiKeyId": "", "source": "" }, "documentRef": "", "lookupId": "", "orgId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "_lookupCaller": { "type": "object" }, "documentRef": { "type": "string" }, "lookupId": { "type": "string" }, "orgId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "expiresAt": "2026-01-31T12:00:00Z", "fileName": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "expiresAt": { "format": "date-time", "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url", "expiresAt", "fileName" ], "type": [ "object", "null" ] } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:lookup\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:lookup\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:lookup", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Fetch lookup document", "tags": [ "Other product features" ], "x-required-scope": "causas:lookup" } }, "/api/actions/causa-lookup/queries/list-lookups": { "post": { "description": "The organization's consultas of the last 7 days, or one of them in full with args[0].lookupId (reopening is free).\n\nAuthentication: developer API key. Required scope: `causas:lookup`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-causa-lookup-queries-list-lookups", "requestBody": { "content": { "application/json": { "example": { "args": [ { "lookupId": "", "orgId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "lookupId": { "type": "string" }, "orgId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "lookupId": "string", "competence": "string", "rol": "string", "caratulado": "string", "tribunal": "string", "source": "string", "fetchedAt": "string" } ], "lookupId": "string", "fetchedAt": "2026-01-31T12:00:00Z", "cached": true, "causa": "string", "documents": "string", "follow": { "competence": "string", "corteId": 0, "tribunalId": 0, "libro": "string", "val": "string", "year": "string" }, "prices": { "consulta": 0, "documento": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "cached": { "type": "boolean" }, "causa": { "type": "string" }, "documents": { "description": "Documents.", "type": "string" }, "fetchedAt": { "format": "date-time", "type": "string" }, "follow": { "properties": { "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": "integer" }, "libro": { "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" }, "val": { "type": "string" }, "year": { "type": "string" } }, "required": [ "competence", "corteId", "tribunalId", "libro", "val", "year" ], "type": "object" }, "items": { "description": "The records returned.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "fetchedAt": { "type": "string" }, "lookupId": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "source": { "description": "Where the record came from.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "lookupId", "competence", "rol", "caratulado", "tribunal", "source", "fetchedAt" ], "type": "object" }, "type": "array" }, "lookupId": { "type": "string" }, "prices": { "description": "Only on the list (no lookupId).", "properties": { "consulta": { "description": "Price of the next lookup in CLP, IVA included; 0 inside the monthly allowance or when exempt.", "type": "integer" }, "documento": { "description": "Price of the next document download in CLP, IVA included.", "type": "integer" } }, "required": [ "consulta", "documento" ], "type": "object" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:lookup\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:lookup\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:lookup", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List lookups", "tags": [ "Other product features" ], "x-required-scope": "causas:lookup" } }, "/api/actions/causa-lookup/queries/lookup-causa": { "post": { "description": "Consulta única: look a public PJUD causa up once, live -- every cuaderno (historias, notificaciones, escritos por resolver, litigantes, exhortos, plazos...), no files downloaded, not added to the organization. Billed per consulta (PJUD_LOOKUP). args[0]: competence (CIVIL, LABORAL, COBRANZA, PENAL, APELACIONES, SUPREMA; FAMILIA is reserved and refused), rol as PJUD prints it (\"C-1234-2024\") or libro + val + year, tribunalId (or corteId for APELACIONES) from get-ojv-catalogs; orgId defaults to the key's organization. Every document carries a documentRef for fetch-lookup-document. A public causa looked up again within 30 minutes is answered from that lookup (cached=true) and still billed.\n\nAuthentication: developer API key. Required scope: `causas:lookup`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-causa-lookup-queries-lookup-causa", "requestBody": { "content": { "application/json": { "example": { "args": [ { "_lookupCaller": { "apiKeyId": "", "source": "" }, "clientIds": [], "competence": "", "corteId": 0, "libro": "", "orgId": "", "private": false, "rol": "", "teamIds": [], "tribunalId": 0, "val": "", "year": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "_lookupCaller": { "type": "object" }, "clientIds": { "items": { "type": "string" }, "type": "array" }, "competence": { "type": "string" }, "corteId": { "type": "number" }, "libro": { "type": "string" }, "orgId": { "type": "string" }, "private": { "type": "boolean" }, "rol": { "type": "string" }, "teamIds": { "items": { "type": "string" }, "type": "array" }, "tribunalId": { "type": "number" }, "val": { "type": "string" }, "year": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "queueable": true, "data": { "lookupId": "string", "fetchedAt": "2026-01-31T12:00:00Z", "cached": true, "causa": { "basicInfo": { "competence": "string", "rol": "string", "caratulado": "string", "textoDemandas": [ { "index": 0, "doc": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string" } ], "estadosProcesal": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "fechaIng": "2026-01-31T12:00:00Z", "certEnvioId": "string", "ebookId": "string", "etapas": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "anexos": [ { "index": 0, "doc": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "tramite": "string", "codigo": "string", "cantidad": 0, "tipoDoc": "string", "rut": "string", "nombre": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string" } ], "estadosAdmin": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "tipoProcedimiento": "string", "tomos": [ { "tomo": "string", "fojaInicio": "string", "fojaFin": "string", "principal": true } ], "docsCausa": [ { "index": 0, "doc": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string" } ], "obs": { "raw": "string", "relatorAsignado": "string" }, "relator": "string", "incompetencias": [ { "rol": "string", "tribunalId": 0 } ], "ubicaciones": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "ruc": "string", "tribunalOrigenId": 0, "juezAsignado": "string", "tituloEjecutivo": "string", "estadosDeuda": [ { "prestacion": "string", "fechaPrestacion": "2026-01-31T12:00:00Z", "fechaActualizar": "2026-01-31T12:00:00Z", "saldoDeuda": 0, "fechaLiq": "2026-01-31T12:00:00Z", "porcentajeReajuste": 0, "porcentajeInteres": 0 } ], "formaDeInicio": "string", "materias": [ { "codigo": "string", "glosa": "string", "estado": "string", "fechaTermino": "2026-01-31T12:00:00Z" } ], "docErrors": [ "string" ] }, "litigantes": [ { "participante": "string", "rut": "string", "persona": "string", "nombre": "string", "abogadoDefensor": true, "estado": true } ], "exhortos": [ { "rolOrigen": "string", "tipoExhorto": "string", "documentosExhortos": [ { "index": 0, "doc": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string" } ], "fechaOrdenaExhorto": "2026-01-31T12:00:00Z", "fechaIngresaExhorto": "2026-01-31T12:00:00Z", "rolDestino": "string", "tribunalDestino": 0, "tribunalDestinoName": "string", "estadoExhorto": "string", "tribunalOrigen": "string", "docErrors": [ "string" ] } ], "remisiones": [ { "corteId": 0, "tribunalId": 0, "competence": "string", "rol": "string", "texto": "string", "tipo": "string", "fecha": "2026-01-31T12:00:00Z" } ], "notificacionesReceptor": [ { "index": 0, "cuaderno": "string", "datosDelRetiro": "string", "fechaRetiro": "2026-01-31T12:00:00Z", "estado": "string" } ], "plazos": [ { "tipoPlazo": "string", "ambitoAfectado": "string", "fechaInicio": "2026-01-31T12:00:00Z", "fechaTermino": "2026-01-31T12:00:00Z", "duracion": "string", "estado": "string", "tramite": "string", "fechaSuspencion": "2026-01-31T12:00:00Z", "fechaReactivacion": "2026-01-31T12:00:00Z" } ], "liquidaciones": [ { "fechaTramite": "2026-01-31T12:00:00Z", "cuadernoLiq": "string", "estado": "string", "monto": 0, "nombre": "string", "rut": "string" } ], "cuadernosData": [ { "historias": [ { "order": 0, "folio": "string", "nulo": true, "reposicion": true, "mismoFolio": 0, "doc": "string", "especial": true, "sala": "string", "certEnvioId": "string", "anexoType": "string", "anexos": [ { "index": 0, "doc": null, "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "tramite": "string", "codigo": "string", "cantidad": 0, "tipoDoc": "string", "rut": "string", "nombre": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string" } ], "etapa": "string", "estado": "string", "tramite": "string", "descTramite": "string", "fechaTramite": "2026-01-31T12:00:00Z", "segundaFechaTramite": "2026-01-31T12:00:00Z", "fechaRecepcion": "2026-01-31T12:00:00Z", "foja": "string", "georref": { "latitud": 0, "longitud": 0, "lat": 0, "lng": 0, "corrector": 0 }, "docsDescTramite": [ { "doc": null, "fecha": "string", "referencia": "string" } ], "conAudios": true, "rut": "string", "nombre": "string", "monto": 0, "cuadernoLiq": "string", "anexosToken": "string", "docErrors": [ "string" ] } ], "notificaciones": [ { "index": 0, "rol": "string", "estadoNotif": "string", "tipoNotif": "string", "fechaTramite": "2026-01-31T12:00:00Z", "fechaAudiencia": "2026-01-31T12:00:00Z", "tipoPart": "string", "nombre": "string", "tramite": "string", "obsFallida": "string", "ruc": "string", "enteNotificador": "string", "notificationDetail": [ { "idx": 0, "codigo": "string", "fecha": "2026-01-31T12:00:00Z", "tipo": "string", "observación": "string" } ], "identityKey": "string" } ], "escritosPorResolver": [ { "doc": "string", "anexos": [ { "index": 0, "doc": null, "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "tramite": "string", "codigo": "string", "cantidad": 0, "tipoDoc": "string", "rut": "string", "nombre": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string" } ], "fechaIngreso": "2026-01-31T12:00:00Z", "tipo": "string", "solicitante": "string", "referencia": "string", "indexPorFecha": 0, "docErrors": [ "string" ] } ], "cuaderno": { "index": 0, "order": 0, "name": "string", "estadosProcesal": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "etapas": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "tipoProcedimiento": "string" }, "audios": [ { "numero": 0, "audio": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "docErrors": [ "string" ] } ], "diligencias": [ { "index": 0, "docIda": "string", "docVta": "string", "estado": "string", "rit": "string", "ruc": "string", "tipoDiligencia": "string", "referencia": "string", "destinatario": "string", "responsable": "string", "fecha": "2026-01-31T12:00:00Z", "docErrors": [ "string" ], "identityKey": "string" } ], "relaciones": [ { "index": 0, "nombre": "string", "delito": "string", "estado": "string", "fechaCambioEstado": "2026-01-31T12:00:00Z", "identityKey": "string" } ] } ] }, "documents": [ { "documentRef": "string", "kind": "string", "cuaderno": "string", "folio": "string", "fecha": "2026-01-31T12:00:00Z", "descripcion": "string" } ], "follow": { "competence": "string", "corteId": 0, "tribunalId": 0, "libro": "string", "val": "string", "year": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "cached": { "type": "boolean" }, "causa": { "properties": { "basicInfo": { "properties": { "anexos": { "description": "Attachments.", "items": { "properties": { "cantidad": { "type": [ "number", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": [ "string", "null" ] }, "docFisico": { "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "estadoFirma": { "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "certEnvioId": { "description": "PJUD certificate-of-filing id.", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "docErrors": { "items": { "type": "string" }, "type": "array" }, "docsCausa": { "items": { "properties": { "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "ebookId": { "type": [ "string", "null" ] }, "estadosAdmin": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "estadosDeuda": { "items": { "properties": { "fechaActualizar": { "description": "Date the amount was last updated (ISO 8601).", "format": "date-time", "type": "string" }, "fechaLiq": { "description": "Settlement date (ISO 8601).", "format": "date-time", "type": "string" }, "fechaPrestacion": { "description": "Date of the claimed benefit (ISO 8601).", "format": "date-time", "type": "string" }, "porcentajeInteres": { "description": "Interest percentage.", "type": "number" }, "porcentajeReajuste": { "description": "Inflation adjustment percentage.", "type": "number" }, "prestacion": { "description": "Claimed benefit or payment.", "type": "string" }, "saldoDeuda": { "description": "Outstanding debt balance in Chilean pesos.", "type": "number" } }, "required": [ "prestacion", "fechaPrestacion", "fechaActualizar", "saldoDeuda", "fechaLiq", "porcentajeReajuste", "porcentajeInteres" ], "type": "object" }, "type": "array" }, "estadosProcesal": { "description": "Procedural statuses.", "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "etapas": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "fechaIng": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": "string" }, "formaDeInicio": { "type": [ "string", "null" ] }, "incompetencias": { "items": { "properties": { "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" } }, "required": [ "rol", "tribunalId" ], "type": "object" }, "type": "array" }, "juezAsignado": { "type": [ "string", "null" ] }, "materias": { "items": { "properties": { "codigo": { "description": "Short code.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaTermino": { "description": "End date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "glosa": { "description": "Description as PJUD words it.", "type": "string" } }, "required": [ "codigo" ], "type": "object" }, "type": "array" }, "obs": { "description": "Suprema only.", "properties": { "raw": { "description": "Observations block text.", "type": "string" }, "relatorAsignado": { "type": "string" } }, "required": [ "raw" ], "type": "object" }, "relator": { "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": [ "string", "null" ] }, "textoDemandas": { "items": { "properties": { "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" }, "tituloEjecutivo": { "type": [ "string", "null" ] }, "tomos": { "description": "Suprema only: the expediente's volumes.", "items": { "properties": { "fojaFin": { "type": "string" }, "fojaInicio": { "type": "string" }, "principal": { "type": "boolean" }, "tomo": { "type": "string" } }, "required": [ "tomo", "fojaInicio", "fojaFin", "principal" ], "type": "object" }, "type": "array" }, "tribunalOrigenId": { "type": [ "integer", "null" ] }, "ubicaciones": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" } }, "required": [ "competence", "rol", "caratulado", "fechaIng" ], "type": "object" }, "cuadernosData": { "items": { "properties": { "audios": { "items": { "properties": { "audio": { "type": "string" }, "docErrors": { "description": "Documents that failed to download.", "items": { "type": "string" }, "type": "array" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "numero": { "description": "Number.", "type": "integer" }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "numero", "audio" ], "type": "object" }, "type": "array" }, "cuaderno": { "description": "Cuaderno (case-file notebook).", "properties": { "estadosProcesal": { "description": "Procedural statuses.", "items": { "properties": { "changedAt": { "description": "When this value was first seen.", "format": "date-time", "type": "string" }, "counter": { "description": "How many times this value has been seen in a row.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "etapas": { "items": { "properties": { "changedAt": { "description": "When this value was first seen.", "format": "date-time", "type": "string" }, "counter": { "description": "How many times this value has been seen in a row.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "name": { "description": "Display name.", "type": "string" }, "order": { "description": "Sort position.", "type": "integer" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] } }, "required": [ "index", "order", "name" ], "type": "object" }, "diligencias": { "items": { "properties": { "destinatario": { "description": "Recipient.", "type": [ "string", "null" ] }, "docErrors": { "description": "Documents that failed to download.", "items": { "type": "string" }, "type": "array" }, "docIda": { "description": "Outgoing document of the exhorto.", "type": [ "string", "null" ] }, "docVta": { "description": "Returned document of the exhorto.", "type": [ "string", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "identityKey": { "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "responsable": { "description": "Person responsible.", "type": [ "string", "null" ] }, "rit": { "description": "Causa RIT, for courts that number by RIT.", "type": "string" }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": "string" }, "tipoDiligencia": { "description": "Type of court proceeding.", "type": "string" } }, "required": [ "index", "estado", "rit", "ruc", "tipoDiligencia" ], "type": "object" }, "type": "array" }, "escritosPorResolver": { "items": { "properties": { "anexos": { "description": "Anexos; doc is always null in lookups (download through documents).", "items": { "properties": { "cantidad": { "type": [ "number", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "null" }, "docFisico": { "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "estadoFirma": { "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": [ "string", "null" ] }, "docErrors": { "description": "Always omitted from lookup results.", "items": { "type": "string" }, "type": "array" }, "fechaIngreso": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": "string" }, "indexPorFecha": { "description": "Position among the entries of the same date.", "type": "integer" }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "solicitante": { "description": "Who made the request.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "fechaIngreso", "tipo", "solicitante", "indexPorFecha" ], "type": "object" }, "type": "array" }, "historias": { "items": { "properties": { "anexoType": { "description": "Attachment type.", "type": [ "string", "null" ] }, "anexos": { "description": "Anexos; doc is always null in lookups (download through documents).", "items": { "properties": { "cantidad": { "type": [ "number", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "null" }, "docFisico": { "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "estadoFirma": { "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "anexosToken": { "type": [ "string", "null" ] }, "certEnvioId": { "description": "PJUD certificate-of-filing id.", "type": [ "string", "null" ] }, "conAudios": { "description": "Whether hearing audio is attached.", "type": [ "boolean", "null" ] }, "cuadernoLiq": { "description": "Liquidation notebook the entry belongs to.", "type": [ "string", "null" ] }, "descTramite": { "description": "Description of the procedural step.", "type": "string" }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": [ "string", "null" ] }, "docErrors": { "description": "Always omitted from lookup results.", "items": { "type": "string" }, "type": "array" }, "docsDescTramite": { "description": "Documents linked from the trámite description.", "items": { "properties": { "doc": { "description": "Always null in a lookup (PJUD tokens are never returned).", "type": "null" }, "fecha": { "description": "Date (ISO 8601).", "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "doc", "fecha", "referencia" ], "type": "object" }, "type": "array" }, "especial": { "description": "Whether PJUD flags the entry as special.", "type": "boolean" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "etapa": { "description": "Procedural stage.", "type": "string" }, "fechaRecepcion": { "description": "Date received (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaTramite": { "description": "Date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "foja": { "description": "Foja (page number in the court file).", "type": [ "string", "null" ] }, "folio": { "description": "Folio number in the court file.", "type": "string" }, "georref": { "description": "Georeference PJUD attaches to the entry.", "properties": { "corrector": { "description": "Correction value, when PJUD sends one.", "type": "number" }, "lat": { "description": "Alias of latitud.", "type": "number" }, "latitud": { "description": "Latitude; kept as the portal's string if it is not numeric.", "type": "number" }, "lng": { "description": "Alias of longitud.", "type": "number" }, "longitud": { "description": "Longitude; kept as the portal's string if it is not numeric.", "type": "number" } }, "required": [ "latitud", "longitud", "lat", "lng" ], "type": "object" }, "mismoFolio": { "description": "Whether it shares the previous entry's folio.", "type": "integer" }, "monto": { "description": "Amount in Chilean pesos.", "type": [ "integer", "null" ] }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "nulo": { "description": "Whether PJUD marks the entry as void.", "type": "boolean" }, "order": { "description": "Sort position.", "type": [ "integer", "null" ] }, "reposicion": { "description": "Whether the entry is a motion for reconsideration.", "type": "boolean" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "sala": { "description": "Court chamber (sala).", "type": [ "string", "null" ] }, "segundaFechaTramite": { "description": "Second date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": "string" } }, "required": [ "folio", "nulo", "reposicion", "mismoFolio", "especial", "etapa", "tramite", "descTramite" ], "type": "object" }, "type": "array" }, "notificaciones": { "items": { "properties": { "enteNotificador": { "description": "Who served the notification.", "type": [ "string", "null" ] }, "estadoNotif": { "description": "Notification status.", "type": "string" }, "fechaAudiencia": { "description": "Hearing date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaTramite": { "description": "Date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "identityKey": { "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "notificationDetail": { "description": "Notification detail.", "items": { "properties": { "codigo": { "description": "Short code.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "idx": { "description": "Row position.", "type": "integer" }, "observación": { "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "idx", "codigo", "fecha", "tipo", "observación" ], "type": "object" }, "type": "array" }, "obsFallida": { "description": "Note on why the notification failed.", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": [ "string", "null" ] }, "tipoNotif": { "description": "Notification type.", "type": [ "string", "null" ] }, "tipoPart": { "description": "Party role in the causa.", "type": "string" }, "tramite": { "description": "Procedural step.", "type": "string" } }, "required": [ "index", "estadoNotif", "tipoPart", "tramite" ], "type": "object" }, "type": "array" }, "relaciones": { "items": { "properties": { "delito": { "description": "Offense (penal causas).", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaCambioEstado": { "description": "Date of the last status change (ISO 8601).", "format": "date-time", "type": "string" }, "identityKey": { "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": "string" } }, "required": [ "index", "nombre", "delito", "estado", "fechaCambioEstado" ], "type": "object" }, "type": "array" } }, "required": [ "historias", "notificaciones", "escritosPorResolver", "cuaderno", "audios", "diligencias", "relaciones" ], "type": "object" }, "type": "array" }, "exhortos": { "items": { "properties": { "docErrors": { "items": { "type": "string" }, "type": "array" }, "documentosExhortos": { "description": "Documents of the exhorto.", "items": { "properties": { "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "estadoExhorto": { "description": "Exhorto status.", "type": "string" }, "fechaIngresaExhorto": { "description": "Date the exhorto was filed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaOrdenaExhorto": { "description": "Date the exhorto was ordered (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "rolDestino": { "description": "Rol at the receiving court.", "type": "string" }, "rolOrigen": { "description": "Rol at the originating court.", "type": [ "string", "null" ] }, "tipoExhorto": { "description": "Exhorto (letter rogatory) type.", "type": [ "string", "null" ] }, "tribunalDestino": { "description": "Court the case went to.", "type": "integer" }, "tribunalDestinoName": { "type": "string" }, "tribunalOrigen": { "description": "Court the case came from.", "type": "string" } }, "required": [ "rolDestino", "tribunalDestino", "estadoExhorto", "tribunalOrigen" ], "type": "object" }, "type": "array" }, "liquidaciones": { "items": { "properties": { "cuadernoLiq": { "description": "Liquidation notebook the entry belongs to.", "type": [ "string", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fechaTramite": { "description": "Date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "monto": { "description": "Amount in Chilean pesos.", "type": [ "number", "null" ] }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "litigantes": { "items": { "properties": { "abogadoDefensor": { "description": "Defense attorney.", "type": [ "boolean", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": [ "boolean", "null" ] }, "nombre": { "description": "Display name.", "type": "string" }, "participante": { "description": "Parties to the causa.", "type": [ "string", "null" ] }, "persona": { "description": "Party name.", "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] } }, "required": [ "persona", "nombre" ], "type": "object" }, "type": "array" }, "notificacionesReceptor": { "items": { "properties": { "cuaderno": { "description": "Cuaderno (case-file notebook).", "type": "string" }, "datosDelRetiro": { "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaRetiro": { "format": "date-time", "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" } }, "required": [ "index", "cuaderno", "datosDelRetiro", "fechaRetiro", "estado" ], "type": "object" }, "type": "array" }, "plazos": { "items": { "properties": { "ambitoAfectado": { "description": "Scope the deadline affects.", "type": "string" }, "duracion": { "description": "Duration.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaInicio": { "description": "Start date (ISO 8601).", "format": "date-time", "type": "string" }, "fechaReactivacion": { "description": "Date reactivated (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaSuspencion": { "description": "Date suspended (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaTermino": { "description": "End date (ISO 8601).", "format": "date-time", "type": "string" }, "tipoPlazo": { "description": "Deadline type.", "type": "string" }, "tramite": { "description": "Procedural step.", "type": "string" } }, "required": [ "tipoPlazo", "ambitoAfectado", "fechaInicio", "fechaTermino", "duracion", "estado", "tramite" ], "type": "object" }, "type": "array" }, "remisiones": { "items": { "properties": { "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "texto": { "type": [ "string", "null" ] }, "tipo": { "description": "Record type.", "type": [ "string", "null" ] }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "competence", "rol" ], "type": "object" }, "type": "array" } }, "required": [ "basicInfo", "litigantes", "exhortos", "remisiones", "notificacionesReceptor", "plazos", "liquidaciones", "cuadernosData" ], "type": "object" }, "documents": { "description": "Documents.", "items": { "properties": { "cuaderno": { "description": "Cuaderno (case-file notebook).", "type": "string" }, "descripcion": { "type": "string" }, "documentRef": { "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "folio": { "description": "Folio number in the court file.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" } }, "required": [ "documentRef", "kind" ], "type": "object" }, "type": "array" }, "fetchedAt": { "format": "date-time", "type": "string" }, "follow": { "properties": { "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": "integer" }, "libro": { "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" }, "val": { "type": "string" }, "year": { "type": "string" } }, "required": [ "competence", "corteId", "tribunalId", "libro", "val", "year" ], "type": "object" }, "lookupId": { "type": "string" } }, "required": [ "lookupId", "fetchedAt", "cached", "causa", "documents", "follow" ], "type": [ "object", "null" ] }, "queueable": { "type": "boolean" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:lookup\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:lookup\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:lookup", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Lookup causa", "tags": [ "Other product features" ], "x-required-scope": "causas:lookup" } }, "/api/actions/cause-assignments/mutations/create-cause-assignment": { "post": { "description": "Create causa assignment\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cause-assignments-mutations-create-cause-assignment", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "role": "", "teamId": "", "userId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "role": { "type": "string" }, "teamId": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "errorEn": "string", "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "errorEn": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create causa assignment", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/cause-assignments/mutations/delete-cause-assignment": { "post": { "description": "Delete causa assignment\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cause-assignments-mutations-delete-cause-assignment", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete causa assignment", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/cause-assignments/mutations/delete-cause-assignments-for-user": { "post": { "description": "Delete causa assignments for user\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cause-assignments-mutations-delete-cause-assignments-for-user", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "userId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete causa assignments for user", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "causas:write" } }, "/api/actions/cause-assignments/queries/get-linked-cause-people": { "post": { "description": "Get linked causa people\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cause-assignments-queries-get-linked-cause-people", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "people": [ { "userId": "string", "name": "string", "email": "string", "roles": [ "string" ] } ], "teams": [ { "id": "string", "name": "string", "assigned": true } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "people": { "items": { "properties": { "email": { "description": "Email address.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "email", "roles" ], "type": "object" }, "type": "array" }, "teams": { "description": "Teams.", "items": { "properties": { "assigned": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name", "assigned" ], "type": "object" }, "type": "array" } }, "required": [ "people", "teams" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get linked causa people", "tags": [ "Expedientes and activity" ], "x-required-scope": "causas:read" } }, "/api/actions/chat/collaboration/mark-chat-read": { "post": { "description": "Mark chat read\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-collaboration-mark-chat-read", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "", "sequence": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" }, "sequence": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "sequence": 0, "unchanged": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "sequence": { "description": "Monotonic position within the conversation.", "type": "integer" }, "unchanged": { "type": "boolean" } }, "required": [ "conversationId", "sequence" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark chat read", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/collaboration/pin-chat-message": { "post": { "description": "Pin chat message\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-collaboration-pin-chat-message", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "messageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "messageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "messageId": "string", "active": true, "conversationId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "messageId": { "description": "Chat message id.", "type": "string" } }, "required": [ "messageId", "active", "conversationId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Pin chat message", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/collaboration/set-chat-conversation-muted": { "post": { "description": "Set chat conversation muted\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-collaboration-set-chat-conversation-muted", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "", "hours": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" }, "hours": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "mutedUntil": "2026-01-31T12:00:00Z" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "mutedUntil": { "description": "Muted until (ISO 8601); null when not muted.", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "conversationId", "mutedUntil" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set chat conversation muted", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/collaboration/toggle-chat-reaction": { "post": { "description": "Toggle chat reaction\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-collaboration-toggle-chat-reaction", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "emoji": "", "messageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "emoji": { "type": "string" }, "messageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "messageId": "string", "emoji": "string", "active": true, "conversationId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "emoji": { "type": "string" }, "messageId": { "description": "Chat message id.", "type": "string" } }, "required": [ "messageId", "emoji", "active", "conversationId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Toggle chat reaction", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/collaboration/toggle-chat-star": { "post": { "description": "Toggle chat star\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-collaboration-toggle-chat-star", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "messageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "messageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "messageId": "string", "active": true, "conversationId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "messageId": { "description": "Chat message id.", "type": "string" } }, "required": [ "messageId", "active", "conversationId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Toggle chat star", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/members/add-chat-member": { "post": { "description": "Add chat member\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-members-add-chat-member", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003cconversationID\u003e", "\u003cuserID\u003e" ] }, "schema": { "properties": { "args": { "prefixItems": [ { "description": "conversationID", "type": "string" }, { "description": "userID", "type": "string" } ], "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "added": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "added": { "type": "boolean" } }, "required": [ "added" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add chat member", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/members/leave-chat-conversation": { "post": { "description": "Leave chat conversation\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-members-leave-chat-conversation", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "left": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "left": { "type": "boolean" } }, "required": [ "left" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Leave chat conversation", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/members/list-chat-members": { "post": { "description": "List chat members\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-members-list-chat-members", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003cconversationID\u003e" ] }, "schema": { "properties": { "args": { "items": { "description": "conversationID", "type": "string" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "members": [ { "userId": "string", "name": "string", "image": "string", "role": "string", "joinedAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "members": { "description": "Members.", "items": { "properties": { "image": { "type": "string" }, "joinedAt": { "format": "date-time", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "role": { "description": "Role.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "image", "role", "joinedAt" ], "type": "object" }, "type": "array" } }, "required": [ "conversationId", "members" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List chat members", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/members/remove-chat-member": { "post": { "description": "Remove chat member\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-members-remove-chat-member", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003ccid\u003e", "\u003cuid\u003e", "\u003crole\u003e" ] }, "schema": { "properties": { "args": { "prefixItems": [ { "description": "cid", "type": "string" }, { "description": "uid", "type": "string" }, { "description": "role", "type": "string" } ], "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "updated": true, "removed": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "removed": { "description": "Number of records removed.", "type": "boolean" }, "updated": { "description": "Whether anything changed.", "type": "boolean" } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove chat member", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/members/set-chat-member-role": { "post": { "description": "Set chat member role\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-members-set-chat-member-role", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003ccid\u003e", "\u003cuid\u003e", "\u003crole\u003e" ] }, "schema": { "properties": { "args": { "prefixItems": [ { "description": "cid", "type": "string" }, { "description": "uid", "type": "string" }, { "description": "role", "type": "string" } ], "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "updated": true, "removed": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "removed": { "description": "Number of records removed.", "type": "boolean" }, "updated": { "description": "Whether anything changed.", "type": "boolean" } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set chat member role", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/messages/delete-chat-message": { "post": { "description": "Delete chat message\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-messages-delete-chat-message", "requestBody": { "content": { "application/json": { "example": { "args": [ { "messageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "messageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "messageId": "string", "deleted": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "deleted": { "description": "Whether the record was deleted.", "type": "boolean" }, "messageId": { "description": "Chat message id.", "type": "string" } }, "required": [ "messageId", "deleted" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete chat message", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/messages/edit-chat-message": { "post": { "description": "Edit chat message\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-messages-edit-chat-message", "requestBody": { "content": { "application/json": { "example": { "args": [ { "body": "", "messageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "body": { "type": "string" }, "messageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "messageId": "string", "body": "string", "edited": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "body": { "description": "Message text.", "type": "string" }, "edited": { "type": "boolean" }, "messageId": { "description": "Chat message id.", "type": "string" } }, "required": [ "messageId", "body", "edited" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Edit chat message", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/messages/forward-chat-message": { "post": { "description": "Forward chat message\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-messages-forward-chat-message", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationIds": [], "messageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationIds": { "items": { "type": "string" }, "type": "array" }, "messageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "forwarded": [ { "conversationId": "string", "id": "string", "sequence": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "forwarded": { "items": { "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "sequence": { "description": "Monotonic position within the conversation.", "type": "integer" } }, "required": [ "conversationId", "id", "sequence" ], "type": "object" }, "type": "array" } }, "required": [ "forwarded" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Forward chat message", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/messages/get-chat-messages": { "post": { "description": "Get chat messages\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-messages-get-chat-messages", "requestBody": { "content": { "application/json": { "example": { "args": [ { "before": 0, "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "before": { "type": "number" }, "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "members": [ { "userId": "string", "name": "string", "image": "string", "role": "MEMBER", "lastRead": 0 } ], "messages": [ { "id": "string", "sequence": 0, "authorId": "string", "canEdit": true, "canDelete": true, "canPin": true, "authorName": "string", "body": "string", "parentId": "string", "createdAt": "2026-01-31T12:00:00Z", "editedAt": "2026-01-31T12:00:00Z", "deleted": true, "starred": true, "pinnedAt": "2026-01-31T12:00:00Z", "forwardedFromId": "string", "reactions": [ { "emoji": "string", "count": 0, "userIds": [ "string" ], "mine": true } ], "mentionedIds": [ "string" ], "linkPreview": { "url": "string", "title": "string", "description": "string", "image": "string", "siteName": "string" }, "parentPreview": { "authorName": "string", "body": "string" }, "attachments": [ { "id": "string", "filename": "string", "mimeType": "string", "bytes": 0, "sha256": "string", "state": "string", "durationMs": 0, "url": "string" } ] } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "members": { "description": "Current members of the conversation.", "items": { "properties": { "image": { "description": "Avatar URL; empty when none.", "type": "string" }, "lastRead": { "description": "Sequence of the last message the member read (for read receipts).", "type": "integer" }, "name": { "description": "Display name.", "type": "string" }, "role": { "description": "Role.", "enum": [ "MEMBER", "ADMIN" ], "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "image", "role", "lastRead" ], "type": "object" }, "type": "array" }, "messages": { "description": "Chat messages, oldest first.", "items": { "properties": { "attachments": { "description": "Attachments.", "items": { "properties": { "bytes": { "description": "Size in bytes.", "type": "integer" }, "durationMs": { "description": "Audio/video duration.", "type": [ "integer", "null" ] }, "filename": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "sha256": { "type": "string" }, "state": { "description": "Scan state (READY, REVIEW_REQUIRED, ...).", "type": "string" }, "url": { "description": "Short-lived signed download URL; only for READY attachments.", "format": "uri", "type": "string" } }, "required": [ "id", "filename", "mimeType", "bytes", "sha256", "state", "durationMs" ], "type": "object" }, "type": "array" }, "authorId": { "description": "Id of the user who wrote it.", "type": "string" }, "authorName": { "description": "Name of the user who wrote it.", "type": "string" }, "body": { "description": "Message text.", "type": "string" }, "canDelete": { "type": "boolean" }, "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "canPin": { "type": "boolean" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "deleted": { "description": "Whether the record was deleted.", "type": "boolean" }, "editedAt": { "description": "When it was last edited (ISO 8601); null if never.", "format": "date-time", "type": [ "string", "null" ] }, "forwardedFromId": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "linkPreview": { "description": "Preview of the first link in the body, once fetched; absent otherwise and on deleted messages.", "properties": { "description": { "description": "Free-text description.", "type": "string" }, "image": { "description": "Preview image URL.", "type": "string" }, "siteName": { "type": "string" }, "title": { "description": "Title.", "type": "string" }, "url": { "description": "Absolute URL.", "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" }, "mentionedIds": { "description": "Ids of the users mentioned.", "items": { "type": "string" }, "type": "array" }, "parentId": { "type": [ "string", "null" ] }, "parentPreview": { "properties": { "authorName": { "description": "Name of the user who wrote it.", "type": "string" }, "body": { "description": "Message text.", "type": "string" } }, "required": [ "authorName", "body" ], "type": "object" }, "pinnedAt": { "description": "When it was pinned (ISO 8601); null if not pinned.", "format": "date-time", "type": [ "string", "null" ] }, "reactions": { "description": "Reactions grouped by emoji, in order of first use.", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "emoji": { "type": "string" }, "mine": { "description": "Whether the caller reacted with this emoji.", "type": "boolean" }, "userIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "emoji", "count", "userIds", "mine" ], "type": "object" }, "type": "array" }, "sequence": { "description": "Monotonic position within the conversation.", "type": "integer" }, "starred": { "type": "boolean" } }, "required": [ "id", "sequence", "authorId", "canEdit", "canDelete", "canPin", "authorName", "body", "parentId", "createdAt", "editedAt", "deleted", "starred", "pinnedAt", "forwardedFromId", "reactions", "mentionedIds", "attachments" ], "type": "object" }, "type": "array" } }, "required": [ "conversationId", "members", "messages" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get chat messages", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/messages/search-chat-messages": { "post": { "description": "Search chat messages\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-messages-search-chat-messages", "requestBody": { "content": { "application/json": { "example": { "args": [ { "beforeMessageId": "", "conversationId": "", "query": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "beforeMessageId": { "type": "string" }, "conversationId": { "type": "string" }, "query": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "query": "string", "results": [ { "id": "string", "conversationId": "string", "conversationType": "string", "conversationName": "string", "sequence": 0, "authorId": "string", "authorName": "string", "body": "string", "createdAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "query": { "description": "The query that was run.", "type": "string" }, "results": { "description": "The results.", "items": { "properties": { "authorId": { "description": "Id of the user who wrote it.", "type": "string" }, "authorName": { "description": "Name of the user who wrote it.", "type": "string" }, "body": { "description": "Message text.", "type": "string" }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "conversationName": { "type": "string" }, "conversationType": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "sequence": { "description": "Monotonic position within the conversation.", "type": "integer" } }, "required": [ "id", "conversationId", "conversationType", "conversationName", "sequence", "authorId", "authorName", "body", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "query", "results" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search chat messages", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/messages/send-chat-message": { "post": { "description": "Send a chat message\n\nAuthentication: developer API key with `communications:write` scope. Send text as JSON `{\"args\":[{...}]}`. For attachments, send multipart form field `args` as JSON and files as `attachment-0`, `attachment-1`, and so on.", "operationId": "actions-chat-messages-send-chat-message", "requestBody": { "content": { "application/json": { "example": { "args": [ { "body": "Hello", "clientMessageId": "\u003cCLIENT_MESSAGE_ID\u003e", "conversationId": "\u003cCONVERSATION_ID\u003e" } ] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "sequence": 0, "deduplicated": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "deduplicated": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "sequence": { "description": "Monotonic position within the conversation.", "type": "integer" } }, "required": [ "id", "sequence" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send chat message", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/moderation/block-chat-user": { "post": { "description": "Block chat user\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-moderation-block-chat-user", "requestBody": { "content": { "application/json": { "example": { "args": [ { "userId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "userId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "userId": "string", "blocked": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "blocked": { "type": "boolean" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "blocked" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Block chat user", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/moderation/list-blocked-chat-users": { "post": { "description": "List blocked chat users\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-moderation-list-blocked-chat-users", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "users": [ { "userId": "string", "name": "string", "createdAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "users": { "description": "Users.", "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "users" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List blocked chat users", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/moderation/list-chat-reports": { "post": { "description": "List chat reports\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-moderation-list-chat-reports", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "reports": [ { "id": "string", "messageId": "string", "reason": "string", "details": "string", "status": "string", "createdAt": "2026-01-31T12:00:00Z", "reportedUserId": "string", "reportedUserName": "string", "message": "string", "reporterId": "string", "reporterName": "string" } ], "attachmentReviews": [ { "id": "string", "messageId": "string", "filename": "string", "mimeType": "string", "bytes": 0, "durationMs": 0, "message": "string", "authorName": "string", "createdAt": "2026-01-31T12:00:00Z", "url": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "attachmentReviews": { "items": { "properties": { "authorName": { "description": "Name of the user who wrote it.", "type": "string" }, "bytes": { "description": "Size in bytes.", "type": "integer" }, "createdAt": { "description": "When the message carrying the attachment was sent.", "format": "date-time", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": [ "integer", "null" ] }, "filename": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "message": { "type": "string" }, "messageId": { "description": "Chat message id.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "id", "messageId", "filename", "mimeType", "bytes", "durationMs", "message", "authorName", "createdAt", "url" ], "type": "object" }, "type": "array" }, "reports": { "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "details": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "message": { "type": "string" }, "messageId": { "description": "Chat message id.", "type": "string" }, "reason": { "description": "Why this happened.", "type": "string" }, "reportedUserId": { "type": "string" }, "reportedUserName": { "type": "string" }, "reporterId": { "type": "string" }, "reporterName": { "type": "string" }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "id", "messageId", "reason", "details", "status", "createdAt", "reportedUserId", "reportedUserName", "message", "reporterId", "reporterName" ], "type": "object" }, "type": "array" } }, "required": [ "reports", "attachmentReviews" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List chat reports", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/moderation/report-chat-message": { "post": { "description": "Report chat message\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-moderation-report-chat-message", "requestBody": { "content": { "application/json": { "example": { "args": [ { "details": "", "messageId": "", "reason": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "details": { "type": "string" }, "messageId": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "reported": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "reported": { "type": "boolean" } }, "required": [ "reported" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Report chat message", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/moderation/review-chat-report": { "post": { "description": "Review chat report\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-moderation-review-chat-report", "requestBody": { "content": { "application/json": { "example": { "args": [ { "attachmentId": "", "decision": "", "reportId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "attachmentId": { "type": "string" }, "decision": { "type": "string" }, "reportId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "attachmentId": "string", "state": "string", "reportId": "string", "status": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "attachmentId": { "type": "string" }, "reportId": { "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "status": { "description": "Current status.", "type": "string" } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Review chat report", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/moderation/unblock-chat-user": { "post": { "description": "Unblock chat user\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-moderation-unblock-chat-user", "requestBody": { "content": { "application/json": { "example": { "args": [ { "userId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "userId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "userId": "string", "blocked": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "blocked": { "type": "boolean" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "blocked" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Unblock chat user", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/mutations/create-chat-conversation": { "post": { "description": "Create chat conversation\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-mutations-create-chat-conversation", "requestBody": { "content": { "application/json": { "example": { "args": [ { "memberIds": [], "name": "", "type": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "memberIds": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create chat conversation", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/mutations/rename-chat-conversation": { "post": { "description": "Rename chat conversation\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-mutations-rename-chat-conversation", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "", "name": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "name": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "conversationId", "name" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Rename chat conversation", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/mutations/set-chat-conversation-archived": { "post": { "description": "Set chat conversation archived\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-mutations-set-chat-conversation-archived", "requestBody": { "content": { "application/json": { "example": { "args": [ { "archived": false, "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "archived": { "type": "boolean" }, "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "archived": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "archived": { "description": "Whether the record is archived.", "type": "boolean" }, "conversationId": { "description": "Chat conversation id.", "type": "string" } }, "required": [ "conversationId", "archived" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set chat conversation archived", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/notifications/get-notification-preference": { "post": { "description": "Get notification preference\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-notifications-get-notification-preference", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003cconversationID\u003e" ] }, "schema": { "properties": { "args": { "items": { "description": "conversationID", "type": "string" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "level": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "level": { "type": "string" } }, "required": [ "conversationId", "level" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get notification preference", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/notifications/get-web-push-config": { "post": { "description": "Get web push config\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-notifications-get-web-push-config", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "enabled": true, "vapidPublicKey": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" }, "vapidPublicKey": { "type": "string" } }, "required": [ "enabled", "vapidPublicKey" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get web push config", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/notifications/set-notification-preference": { "post": { "description": "Set notification preference\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-notifications-set-notification-preference", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003cconversationID\u003e", "\u003clevel\u003e" ] }, "schema": { "properties": { "args": { "prefixItems": [ { "description": "conversationID", "type": "string" }, { "description": "level", "type": "string" } ], "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "level": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "level": { "type": "string" } }, "required": [ "conversationId", "level" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set notification preference", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/chat/presence/get-chat-presence": { "post": { "description": "Get chat presence\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-presence-get-chat-presence", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "online": [ "string" ], "typing": [ { "userId": "string", "name": "string" } ], "members": [ { "userId": "string", "name": "string", "image": "string", "role": "MEMBER", "lastRead": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "members": { "description": "Current members of the conversation.", "items": { "properties": { "image": { "description": "Avatar URL; empty when none.", "type": "string" }, "lastRead": { "description": "Sequence of the last message the member read (for read receipts).", "type": "integer" }, "name": { "description": "Display name.", "type": "string" }, "role": { "description": "Role.", "enum": [ "MEMBER", "ADMIN" ], "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "image", "role", "lastRead" ], "type": "object" }, "type": "array" }, "online": { "items": { "type": "string" }, "type": "array" }, "typing": { "items": { "properties": { "name": { "description": "Display name.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name" ], "type": "object" }, "type": "array" } }, "required": [ "conversationId", "online", "typing", "members" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get chat presence", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/queries/get-chat-events": { "post": { "description": "Get chat events\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-queries-get-chat-events", "requestBody": { "content": { "application/json": { "example": { "args": [ { "after": 0, "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "after": { "type": "number" }, "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "events": [ { "id": "string", "type": "string", "payload": {}, "sequence": 0, "createdAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "events": { "description": "Events, newest first.", "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "payload": { "description": "Event payload as stored in the chat outbox; its keys depend on the event type (message ids, member changes, reactions, ...)." }, "sequence": { "description": "Monotonic position within the conversation.", "type": "integer" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "type", "payload", "sequence", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "events" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get chat events", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/queries/get-chat-typing": { "post": { "description": "Get chat typing\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-queries-get-chat-typing", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "typing": [ { "userId": "string", "name": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "typing": { "items": { "properties": { "name": { "description": "Display name.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name" ], "type": "object" }, "type": "array" } }, "required": [ "typing" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get chat typing", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/queries/list-chat-conversations": { "post": { "description": "List chat conversations\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-queries-list-chat-conversations", "requestBody": { "content": { "application/json": { "example": { "args": [ { "includeArchived": false } ] }, "schema": { "properties": { "args": { "items": { "properties": { "includeArchived": { "type": "boolean" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversations": [ { "id": "string", "type": "string", "name": "string", "title": "string", "caseType": "string", "caseId": "string", "lastSequence": 0, "lastRead": 0, "unread": 0, "mentions": 0, "updatedAt": "2026-01-31T12:00:00Z", "archived": true, "memberCount": 0, "canModerate": true, "mutedUntil": "2026-01-31T12:00:00Z", "lastMessage": { "body": "string", "deleted": true, "authorName": "string", "authorId": "string", "createdAt": "2026-01-31T12:00:00Z", "attachments": 0, "mine": true } } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversations": { "items": { "properties": { "archived": { "description": "Whether the record is archived.", "type": "boolean" }, "canModerate": { "type": "boolean" }, "caseId": { "description": "Case id; see `caseType` for which kind.", "type": [ "string", "null" ] }, "caseType": { "description": "`TRACKED` for a PJUD causa, `INTERNAL` for an expediente.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "lastMessage": { "properties": { "attachments": { "description": "Attachments.", "type": "integer" }, "authorId": { "description": "Id of the user who wrote it.", "type": "string" }, "authorName": { "description": "Name of the user who wrote it.", "type": "string" }, "body": { "description": "Message text.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "deleted": { "description": "Whether the record was deleted.", "type": "boolean" }, "mine": { "description": "Whether it belongs to the API key's acting user.", "type": "boolean" } }, "required": [ "body", "deleted", "authorName", "authorId", "createdAt", "attachments", "mine" ], "type": "object" }, "lastRead": { "type": "integer" }, "lastSequence": { "type": "integer" }, "memberCount": { "type": "integer" }, "mentions": { "type": "integer" }, "mutedUntil": { "description": "Muted until (ISO 8601); null when not muted.", "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "Display name.", "type": [ "string", "null" ] }, "title": { "description": "Title.", "type": "string" }, "type": { "description": "Record type.", "type": "string" }, "unread": { "type": "integer" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "type", "name", "title", "caseType", "caseId", "lastSequence", "lastRead", "unread", "mentions", "updatedAt", "archived", "memberCount", "canModerate" ], "type": "object" }, "type": "array" } }, "required": [ "conversations" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List chat conversations", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/queries/list-chat-pinned-messages": { "post": { "description": "List chat pinned messages\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-queries-list-chat-pinned-messages", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "messages": [ { "id": "string", "sequence": 0, "authorName": "string", "body": "string", "createdAt": "2026-01-31T12:00:00Z", "pinnedAt": "2026-01-31T12:00:00Z", "pinnedByName": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "messages": { "description": "Chat messages, oldest first.", "items": { "properties": { "authorName": { "description": "Name of the user who wrote it.", "type": "string" }, "body": { "description": "Message text.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "pinnedAt": { "description": "When it was pinned (ISO 8601); null if not pinned.", "format": "date-time", "type": "string" }, "pinnedByName": { "type": "string" }, "sequence": { "description": "Monotonic position within the conversation.", "type": "integer" } }, "required": [ "id", "sequence", "authorName", "body", "createdAt", "pinnedAt", "pinnedByName" ], "type": "object" }, "type": "array" } }, "required": [ "conversationId", "messages" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List chat pinned messages", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/queries/list-chat-starred-messages": { "post": { "description": "List chat starred messages\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-queries-list-chat-starred-messages", "requestBody": { "content": { "application/json": { "example": { "args": [ { "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "conversationId": "string", "messages": [ { "id": "string", "sequence": 0, "authorName": "string", "body": "string", "createdAt": "2026-01-31T12:00:00Z", "starredAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conversationId": { "description": "Chat conversation id.", "type": "string" }, "messages": { "description": "Chat messages, oldest first.", "items": { "properties": { "authorName": { "description": "Name of the user who wrote it.", "type": "string" }, "body": { "description": "Message text.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "sequence": { "description": "Monotonic position within the conversation.", "type": "integer" }, "starredAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "sequence", "authorName", "body", "createdAt", "starredAt" ], "type": "object" }, "type": "array" } }, "required": [ "conversationId", "messages" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List chat starred messages", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/chat/queries/send-chat-typing": { "post": { "description": "Send chat typing\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-chat-queries-send-chat-typing", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "conversationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "conversationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send chat typing", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/clients/link/create-client-from-litigant": { "post": { "description": "Create client from litigant\n\nAuthentication: developer API key. Required scope: `clients:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-clients-link-create-client-from-litigant", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "email": "", "name": "", "rut": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "rut": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "clientId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "clientId": { "description": "Client id.", "type": "string" } }, "required": [ "clientId" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"clients:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"clients:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "clients:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create client from litigant", "tags": [ "Clients" ], "x-modifies-data": true, "x-required-scope": "clients:write" } }, "/api/actions/clients/link/link-cause-client": { "post": { "description": "Link causa client\n\nAuthentication: developer API key. Required scope: `clients:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-clients-link-link-cause-client", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "clientId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "clientId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"clients:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"clients:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "clients:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Link causa client", "tags": [ "Clients" ], "x-modifies-data": true, "x-required-scope": "clients:write" } }, "/api/actions/clients/link/link-suggested-clients": { "post": { "description": "Link suggested clients\n\nAuthentication: developer API key. Required scope: `clients:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-clients-link-link-suggested-clients", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaIds": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "linked": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "linked": { "type": "integer" } }, "required": [ "linked" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"clients:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"clients:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "clients:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Link suggested clients", "tags": [ "Clients" ], "x-modifies-data": true, "x-required-scope": "clients:write" } }, "/api/actions/clients/link/list-client-link-suggestions": { "post": { "description": "List client link suggestions\n\nAuthentication: developer API key. Required scope: `clients:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-clients-link-list-client-link-suggestions", "requestBody": { "content": { "application/json": { "example": { "args": [ { "countOnly": false, "limit": 0, "noClients": false, "offset": 0, "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "countOnly": { "type": "boolean" }, "limit": { "type": "number" }, "noClients": { "type": "boolean" }, "offset": { "type": "number" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "id": "string", "rol": "string", "caratulado": "string", "competence": "string", "litigantes": [ { "personaId": "string", "nombre": "string", "rut": "string", "participante": "string", "matchClientId": "string", "matchClientName": "string" } ] } ], "total": 0, "matched": 0, "canEdit": true, "clients": [ { "id": "string", "name": "string", "rut": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "causas": { "description": "PJUD causas.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "litigantes": { "items": { "properties": { "matchClientId": { "type": "string" }, "matchClientName": { "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "participante": { "description": "Parties to the causa.", "type": "string" }, "personaId": { "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" } }, "required": [ "personaId", "nombre", "rut", "participante", "matchClientId", "matchClientName" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "id", "rol", "caratulado", "competence", "litigantes" ], "type": "object" }, "type": "array" }, "clients": { "description": "Clients linked to the record.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" } }, "required": [ "id", "name", "rut" ], "type": "object" }, "type": "array" }, "matched": { "type": "integer" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "causas", "total", "matched", "canEdit" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"clients:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"clients:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "clients:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List client link suggestions", "tags": [ "Clients" ], "x-required-scope": "clients:read" } }, "/api/actions/clients/mutations/create-client": { "post": { "description": "Create client\n\nAuthentication: developer API key. Required scope: `clients:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-clients-mutations-create-client", "requestBody": { "content": { "application/json": { "example": { "args": [ { "address": "", "claveUnica": "", "defaultClient": false, "id": "", "isInternalLawyer": false, "name": "", "note": "", "passwordType": "", "profesion": "", "rut": "", "withCU": false } ] }, "schema": { "properties": { "args": { "items": { "properties": { "address": { "type": "string" }, "claveUnica": { "type": "string" }, "defaultClient": { "type": "boolean" }, "id": { "type": "string" }, "isInternalLawyer": { "type": "boolean" }, "name": { "type": "string" }, "note": { "type": "string" }, "passwordType": { "type": "string" }, "profesion": { "type": "string" }, "rut": { "type": "string" }, "withCU": { "type": "boolean" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true, "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"clients:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"clients:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "clients:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create client", "tags": [ "Clients" ], "x-modifies-data": true, "x-required-scope": "clients:write" } }, "/api/actions/clients/mutations/update-client": { "post": { "description": "Update client\n\nAuthentication: developer API key. Required scope: `clients:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-clients-mutations-update-client", "requestBody": { "content": { "application/json": { "example": { "args": [ { "address": "", "claveUnica": "", "defaultClient": false, "id": "", "isInternalLawyer": false, "name": "", "note": "", "passwordType": "", "profesion": "", "rut": "", "withCU": false } ] }, "schema": { "properties": { "args": { "items": { "properties": { "address": { "type": "string" }, "claveUnica": { "type": "string" }, "defaultClient": { "type": "boolean" }, "id": { "type": "string" }, "isInternalLawyer": { "type": "boolean" }, "name": { "type": "string" }, "note": { "type": "string" }, "passwordType": { "type": "string" }, "profesion": { "type": "string" }, "rut": { "type": "string" }, "withCU": { "type": "boolean" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true, "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"clients:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"clients:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "clients:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update client", "tags": [ "Clients" ], "x-modifies-data": true, "x-required-scope": "clients:write" } }, "/api/actions/clients/queries/get-clients": { "post": { "description": "List the organization's clients.\n\nAuthentication: developer API key. Required scope: `clients:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-clients-queries-get-clients", "requestBody": { "content": { "application/json": { "example": { "args": [ { "credentialType": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "credentialType": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "clients": [ { "id": "string", "orgId": "string", "organizationName": "string", "name": "string", "rut": "string", "withCU": true, "hasCredential": true, "passwordType": "string", "statusClave": "OK", "lastCheck": "2026-01-31T12:00:00Z", "defaultClient": true, "isInternalLawyer": true, "profesion": "string", "address": "string", "note": "string", "updatedAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "clients": { "description": "Clients linked to the record.", "items": { "properties": { "address": { "description": "Postal address.", "type": [ "string", "null" ] }, "defaultClient": { "description": "Whether it is the organization's default client.", "type": "boolean" }, "hasCredential": { "description": "Whether a PJUD credential (Clave Única or Poder Judicial) is stored.", "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "isInternalLawyer": { "description": "Whether the client is one of the firm's own lawyers.", "type": "boolean" }, "lastCheck": { "description": "Last time access was checked (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "Display name.", "type": "string" }, "note": { "description": "Free-text note.", "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "organizationName": { "description": "Organization name.", "type": "string" }, "passwordType": { "description": "Kind of PJUD credential stored.", "type": "string" }, "profesion": { "description": "Profession.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "statusClave": { "description": "Status of the stored PJUD credential.", "enum": [ "OK", "ERROR", "INCORRECT", "BLOCKED" ], "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "withCU": { "description": "Whether the client's credential is a Clave Única.", "type": "boolean" } }, "required": [ "id", "orgId", "organizationName", "name", "rut", "withCU", "hasCredential", "passwordType", "statusClave", "lastCheck", "defaultClient", "isInternalLawyer", "profesion", "address", "note", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "clients" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"clients:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"clients:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "clients:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get clients", "tags": [ "Clients" ], "x-required-scope": "clients:read" } }, "/api/actions/clients/queries/get-clients-summary": { "post": { "description": "Get clients summary\n\nAuthentication: developer API key. Required scope: `clients:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-clients-queries-get-clients-summary", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "organizationId": "string", "organizationName": "string", "liquidadorEnabled": true, "canWriteSii": true, "kpis": { "clients": 0, "withCU": 0, "statusOk": 0, "incorrect": 0, "blocked": 0, "error": 0, "unvalidated": 0, "noCredential": 0, "causasBlocked": 0, "deudores": 0, "deudoresWithSii": 0, "deudoresWithoutSii": 0 }, "clients": [ { "id": "string", "name": "string", "rut": "string", "withCU": true, "hasCredential": true, "passwordType": "string", "statusClave": "OK", "lastCheck": "2026-01-31T12:00:00Z", "defaultClient": true, "isInternalLawyer": true, "profesion": "string", "updatedAt": "2026-01-31T12:00:00Z", "causas": 0, "causasBlocked": 0, "expedientes": 0 } ], "blockedCauses": [ { "causaId": "string", "rol": "string", "competence": "CIVIL", "caratulado": "string", "errorCategory": "INIT_TIMEOUT", "lastUpdate": "2026-01-31T12:00:00Z", "clientId": "string", "clientName": "string", "clientStatus": "OK" } ], "detectedParties": [ { "rut": "string", "nombre": "string", "role": "string", "causas": 0, "sources": [ "string" ] } ], "lawyers": [ { "userId": "string", "name": "string", "email": "string", "role": "string", "invitation": "string", "responsibleCausas": 0, "blockedCausas": 0, "deudores": 0, "internalLawyerClientId": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "blockedCauses": { "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "clientId": { "description": "Client id.", "type": "string" }, "clientName": { "type": "string" }, "clientStatus": { "enum": [ "OK", "ERROR", "INCORRECT", "BLOCKED" ], "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "enum": [ "CIVIL", "LABORAL", "PENAL", "FAMILIA", "COBRANZA", "SUPREMA", "APELACIONES" ], "type": "string" }, "errorCategory": { "description": "Category of the last scraping error.", "enum": [ "INIT_TIMEOUT", "INIT_CONNECTION_PJUD", "INIT_CONNECTION_CU", "INIT_PARSE_DATA", "CONNECTION", "PARSE_DATA", "NO_VALID_CU", "RESERVED", "NOT_FOUND_WITH_CU", "NOT_FOUND_OR_PRIVATE", "CHECK_DATA", "DOWNLOADS", "SAVE_ERROR", "OTHER" ], "type": [ "string", "null" ] }, "lastUpdate": { "description": "Last time the causa was refreshed from PJUD (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "causaId", "rol", "competence", "caratulado", "errorCategory", "lastUpdate", "clientId", "clientName", "clientStatus" ], "type": "object" }, "type": "array" }, "canWriteSii": { "type": "boolean" }, "clients": { "description": "Clients linked to the record.", "items": { "properties": { "causas": { "description": "PJUD causas.", "type": [ "integer", "null" ] }, "causasBlocked": { "type": [ "integer", "null" ] }, "defaultClient": { "description": "Whether it is the organization's default client.", "type": "boolean" }, "expedientes": { "type": [ "integer", "null" ] }, "hasCredential": { "description": "Whether a PJUD credential (Clave Única or Poder Judicial) is stored.", "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "isInternalLawyer": { "description": "Whether the client is one of the firm's own lawyers.", "type": "boolean" }, "lastCheck": { "description": "Last time access was checked (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "Display name.", "type": "string" }, "passwordType": { "description": "Kind of PJUD credential stored.", "type": "string" }, "profesion": { "description": "Profession.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "statusClave": { "description": "Status of the stored PJUD credential.", "enum": [ "OK", "ERROR", "INCORRECT", "BLOCKED" ], "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "withCU": { "description": "Whether the client's credential is a Clave Única.", "type": "boolean" } }, "required": [ "id", "name", "rut", "withCU", "hasCredential", "passwordType", "statusClave", "lastCheck", "defaultClient", "isInternalLawyer", "profesion", "updatedAt", "causas", "causasBlocked", "expedientes" ], "type": "object" }, "type": "array" }, "detectedParties": { "items": { "properties": { "causas": { "description": "PJUD causas.", "type": "number" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "role": { "description": "Litigant role in OJV (DDO., DTE., ...); null when only seen in the Boletín.", "type": [ "string", "null" ] }, "rut": { "description": "RUT normalized to digits and K (no dots or dash).", "type": "string" }, "sources": { "description": "Where the party was seen: OJV, BC.", "items": { "type": "string" }, "type": "array" } }, "required": [ "rut", "nombre", "role", "causas", "sources" ], "type": "object" }, "type": "array" }, "kpis": { "properties": { "blocked": { "type": "integer" }, "causasBlocked": { "type": "integer" }, "clients": { "description": "Clients linked to the record.", "type": "integer" }, "deudores": { "description": "Debtors.", "type": "integer" }, "deudoresWithSii": { "type": "integer" }, "deudoresWithoutSii": { "type": "integer" }, "error": { "type": "integer" }, "incorrect": { "type": "integer" }, "noCredential": { "type": "integer" }, "statusOk": { "type": "integer" }, "unvalidated": { "type": "integer" }, "withCU": { "description": "Whether the client's credential is a Clave Única.", "type": "integer" } }, "required": [ "clients", "withCU", "statusOk", "incorrect", "blocked", "error", "unvalidated", "noCredential" ], "type": "object" }, "lawyers": { "items": { "properties": { "blockedCausas": { "type": "integer" }, "deudores": { "description": "Debtors.", "type": "integer" }, "email": { "description": "Email address.", "type": "string" }, "internalLawyerClientId": { "type": "string" }, "invitation": { "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "responsibleCausas": { "type": "integer" }, "role": { "description": "Role.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "email", "role", "invitation", "responsibleCausas", "blockedCausas", "deudores" ], "type": "object" }, "type": "array" }, "liquidadorEnabled": { "type": "boolean" }, "organizationId": { "type": "string" }, "organizationName": { "description": "Organization name.", "type": "string" } }, "required": [ "organizationId", "organizationName", "liquidadorEnabled", "canWriteSii", "kpis", "clients", "blockedCauses", "detectedParties", "lawyers" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"clients:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"clients:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "clients:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get clients summary", "tags": [ "Clients" ], "x-required-scope": "clients:read" } }, "/api/actions/cobranza/billing/cancel-billing-note": { "post": { "description": "Cancel billing note\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-cancel-billing-note", "requestBody": { "content": { "application/json": { "example": { "args": [ {} ] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Cancel billing note", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "billing:write" } }, "/api/actions/cobranza/billing/create-billing-note": { "post": { "description": "Create billing note\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-create-billing-note", "requestBody": { "content": { "application/json": { "example": { "args": [ { "clientId": "", "currency": "", "from": "", "includeFixed": false, "includeHours": false, "issue": false, "lines": [], "notes": "", "taxRate": 0, "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "clientId": { "type": "string" }, "currency": { "type": "string" }, "from": { "type": "string" }, "includeFixed": { "type": "boolean" }, "includeHours": { "type": "boolean" }, "issue": { "type": "boolean" }, "lines": { "items": { "type": "object" }, "type": "array" }, "notes": { "type": "string" }, "taxRate": { "type": "number" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "number": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "number": { "type": "integer" } }, "required": [ "id", "number" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create billing note", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "billing:write" } }, "/api/actions/cobranza/billing/delete-billing-rate": { "post": { "description": "Delete billing rate\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-delete-billing-rate", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete billing rate", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "billing:write" } }, "/api/actions/cobranza/billing/get-billing-analytics": { "post": { "description": "Get billing analytics\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-get-billing-analytics", "requestBody": { "content": { "application/json": { "example": { "args": [ { "from": "", "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "from": "2026-01-31", "to": "2026-01-31", "totals": [ { "currency": "string", "collected": 0, "tax": 0, "net": 0, "pending": 0, "overdue": 0 } ], "byMonth": [ { "month": "string", "currency": "string", "billed": 0, "collected": 0 } ], "byStatus": [ { "status": "DRAFT", "currency": "string", "count": 0, "total": 0 } ], "topClients": [ { "client": "string", "currency": "string", "billed": 0, "collected": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "byMonth": { "items": { "properties": { "billed": { "description": "Total of notes that are neither DRAFT nor CANCELLED.", "type": "number" }, "collected": { "description": "Total of PAID notes.", "type": "number" }, "currency": { "type": "string" }, "month": { "description": "YYYY-MM in Chile time.", "type": "string" } }, "required": [ "month", "currency", "billed", "collected" ], "type": "object" }, "type": "array" }, "byStatus": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "currency": { "type": "string" }, "status": { "description": "Current status.", "enum": [ "DRAFT", "ISSUED", "OVERDUE", "PAID", "CANCELLED" ], "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "number" } }, "required": [ "status", "currency", "count", "total" ], "type": "object" }, "type": "array" }, "from": { "description": "Start of the range (ISO 8601).", "format": "date", "type": "string" }, "to": { "description": "End of the range (ISO 8601).", "format": "date", "type": "string" }, "topClients": { "description": "Top 10 clients by billed amount.", "items": { "properties": { "billed": { "type": "number" }, "client": { "description": "Client name.", "type": "string" }, "collected": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "client", "currency", "billed", "collected" ], "type": "object" }, "type": "array" }, "totals": { "description": "Per-currency totals of notes dated in the range (never summed across currencies).", "items": { "properties": { "collected": { "description": "Total of PAID notes.", "type": "number" }, "currency": { "type": "string" }, "net": { "description": "Net of PAID notes.", "type": "number" }, "overdue": { "description": "Total of OVERDUE notes.", "type": "number" }, "pending": { "description": "Total of ISSUED and OVERDUE notes.", "type": "number" }, "tax": { "description": "Tax of PAID notes.", "type": "number" } }, "required": [ "currency", "collected", "tax", "net", "pending", "overdue" ], "type": "object" }, "type": "array" } }, "required": [ "from", "to", "totals", "byMonth", "byStatus", "topClients" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get billing analytics", "tags": [ "Time and billing" ], "x-required-scope": "billing:read" } }, "/api/actions/cobranza/billing/get-billing-bank-account": { "post": { "description": "Get billing bank account\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-get-billing-bank-account", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "bank": { "bank": "string", "accountType": "string", "number": "string", "holderRut": "string", "holderName": "string", "email": "string" }, "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "bank": { "description": "The organization's bank account for transfers; every field is an empty string when none is configured.", "properties": { "accountType": { "type": "string" }, "bank": { "type": "string" }, "email": { "description": "Email address.", "type": "string" }, "holderName": { "type": "string" }, "holderRut": { "type": "string" }, "number": { "type": "string" } }, "required": [ "bank", "accountType", "number", "holderRut", "holderName", "email" ], "type": "object" }, "canManage": { "type": "boolean" } }, "required": [ "bank", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get billing bank account", "tags": [ "Time and billing" ], "x-required-scope": "billing:read" } }, "/api/actions/cobranza/billing/get-billing-note": { "post": { "description": "Get billing note\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-get-billing-note", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "note": { "id": "string", "number": 0, "clientId": "string", "clientName": "string", "clientRut": "string", "status": "string", "issuedAt": "2026-01-31T12:00:00Z", "dueAt": "2026-01-31T12:00:00Z", "currency": "string", "net": 0, "taxRate": 0, "tax": 0, "total": 0, "periodFrom": "2026-01-31T12:00:00Z", "periodTo": "2026-01-31T12:00:00Z", "notes": "string", "paidAt": "2026-01-31T12:00:00Z", "paymentReference": "string", "automatic": true, "createdAt": "2026-01-31T12:00:00Z" }, "lines": [ { "kind": "string", "description": "string", "quantity": 0, "unitAmount": 0, "amount": 0 } ], "bank": { "bank": "string", "accountType": "string", "number": "string", "holderRut": "string", "holderName": "string", "email": "string" }, "orgName": "string", "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "bank": { "description": "The organization's bank account for transfers; every field is an empty string when none is configured.", "properties": { "accountType": { "type": "string" }, "bank": { "type": "string" }, "email": { "description": "Email address.", "type": "string" }, "holderName": { "type": "string" }, "holderRut": { "type": "string" }, "number": { "type": "string" } }, "required": [ "bank", "accountType", "number", "holderRut", "holderName", "email" ], "type": "object" }, "canManage": { "type": "boolean" }, "lines": { "items": { "properties": { "amount": { "description": "Amount.", "type": "number" }, "description": { "description": "Free-text description.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "quantity": { "type": "number" }, "unitAmount": { "type": "number" } }, "required": [ "kind", "description", "quantity", "unitAmount", "amount" ], "type": "object" }, "type": "array" }, "note": { "description": "Free-text note.", "properties": { "automatic": { "type": "boolean" }, "clientId": { "description": "Client id.", "type": "string" }, "clientName": { "type": "string" }, "clientRut": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "issuedAt": { "format": "date-time", "type": [ "string", "null" ] }, "net": { "type": "number" }, "notes": { "description": "Free-text notes.", "type": "string" }, "number": { "type": "integer" }, "paidAt": { "format": "date-time", "type": [ "string", "null" ] }, "paymentReference": { "type": "string" }, "periodFrom": { "format": "date-time", "type": [ "string", "null" ] }, "periodTo": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "description": "Current status.", "type": "string" }, "tax": { "type": "number" }, "taxRate": { "type": "number" }, "total": { "description": "Total number of matching records across all pages.", "type": "number" } }, "required": [ "id", "number", "clientId", "clientName", "clientRut", "status", "issuedAt", "dueAt", "currency", "net", "taxRate", "tax", "total", "periodFrom", "periodTo", "notes", "paidAt", "paymentReference", "automatic", "createdAt" ], "type": "object" }, "orgName": { "description": "Organization name.", "type": "string" } }, "required": [ "note", "lines", "bank", "orgName", "canManage" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get billing note", "tags": [ "Time and billing" ], "x-required-scope": "billing:read" } }, "/api/actions/cobranza/billing/issue-billing-note": { "post": { "description": "Issue billing note\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-issue-billing-note", "requestBody": { "content": { "application/json": { "example": { "args": [ {} ] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Issue billing note", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "billing:write" } }, "/api/actions/cobranza/billing/list-billing-automations": { "post": { "description": "List billing automations\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-list-billing-automations", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "clients": [ { "clientId": "string", "clientName": "string", "rateId": "string", "rateName": "string", "frequency": "string", "dayOfMonth": 0, "dayOfWeek": 0, "dueDays": 0, "nextRunAt": "2026-01-31T12:00:00Z", "autoIssue": true } ], "rates": [ { "id": "string", "name": "string", "hourlyAmount": 0, "fixedAmount": 0, "fixedDescription": "string", "currency": "string", "clients": 0 } ], "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" }, "clients": { "description": "Clients linked to the record.", "items": { "properties": { "autoIssue": { "type": "boolean" }, "clientId": { "description": "Client id.", "type": "string" }, "clientName": { "type": "string" }, "dayOfMonth": { "type": [ "integer", "null" ] }, "dayOfWeek": { "type": [ "integer", "null" ] }, "dueDays": { "type": "integer" }, "frequency": { "type": "string" }, "nextRunAt": { "format": "date-time", "type": [ "string", "null" ] }, "rateId": { "type": "string" }, "rateName": { "type": "string" } }, "required": [ "clientId", "clientName", "rateId", "rateName", "frequency", "dayOfMonth", "dayOfWeek", "dueDays", "nextRunAt", "autoIssue" ], "type": "object" }, "type": "array" }, "rates": { "items": { "properties": { "clients": { "description": "Clients whose billing automation uses this rate.", "type": "integer" }, "currency": { "type": "string" }, "fixedAmount": { "description": "Fixed amount per note; null when the rate has no fixed part.", "type": [ "number", "null" ] }, "fixedDescription": { "type": "string" }, "hourlyAmount": { "description": "Hourly amount; null when the rate has no hourly part.", "type": [ "number", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name", "hourlyAmount", "fixedAmount", "fixedDescription", "currency", "clients" ], "type": "object" }, "type": "array" } }, "required": [ "clients", "rates", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List billing automations", "tags": [ "Time and billing" ], "x-required-scope": "billing:read" } }, "/api/actions/cobranza/billing/list-billing-notes": { "post": { "description": "List billing notes\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-list-billing-notes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "clientId": "", "tab": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "clientId": { "type": "string" }, "tab": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "tab": "string", "notes": [ { "id": "string", "number": 0, "clientId": "string", "clientName": "string", "clientRut": "string", "status": "string", "issuedAt": "2026-01-31T12:00:00Z", "dueAt": "2026-01-31T12:00:00Z", "currency": "string", "net": 0, "taxRate": 0, "tax": 0, "total": 0, "periodFrom": "2026-01-31T12:00:00Z", "periodTo": "2026-01-31T12:00:00Z", "notes": "string", "paidAt": "2026-01-31T12:00:00Z", "paymentReference": "string", "automatic": true, "createdAt": "2026-01-31T12:00:00Z" } ], "counts": { "\u003ckey\u003e": 0 }, "clients": [ { "id": "string", "label": "string" } ], "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" }, "clients": { "description": "The organization's clients (up to 1000), for the client filter.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Client name.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Notes per tab, keyed by tab: attention, open, overdue, closed, all.", "type": "object" }, "notes": { "description": "Free-text notes.", "items": { "properties": { "automatic": { "type": "boolean" }, "clientId": { "description": "Client id.", "type": "string" }, "clientName": { "type": "string" }, "clientRut": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "issuedAt": { "format": "date-time", "type": [ "string", "null" ] }, "net": { "type": "number" }, "notes": { "description": "Free-text notes.", "type": "string" }, "number": { "type": "integer" }, "paidAt": { "format": "date-time", "type": [ "string", "null" ] }, "paymentReference": { "type": "string" }, "periodFrom": { "format": "date-time", "type": [ "string", "null" ] }, "periodTo": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "description": "Current status.", "type": "string" }, "tax": { "type": "number" }, "taxRate": { "type": "number" }, "total": { "description": "Total number of matching records across all pages.", "type": "number" } }, "required": [ "id", "number", "clientId", "clientName", "clientRut", "status", "issuedAt", "dueAt", "currency", "net", "taxRate", "tax", "total", "periodFrom", "periodTo", "notes", "paidAt", "paymentReference", "automatic", "createdAt" ], "type": "object" }, "type": "array" }, "tab": { "type": "string" } }, "required": [ "tab", "notes", "counts", "clients", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List billing notes", "tags": [ "Time and billing" ], "x-required-scope": "billing:read" } }, "/api/actions/cobranza/billing/list-billing-rates": { "post": { "description": "List billing rates\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-list-billing-rates", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rates": [ { "id": "string", "name": "string", "hourlyAmount": 0, "fixedAmount": 0, "fixedDescription": "string", "currency": "string", "clients": 0 } ], "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" }, "rates": { "items": { "properties": { "clients": { "description": "Clients whose billing automation uses this rate.", "type": "integer" }, "currency": { "type": "string" }, "fixedAmount": { "description": "Fixed amount per note; null when the rate has no fixed part.", "type": [ "number", "null" ] }, "fixedDescription": { "type": "string" }, "hourlyAmount": { "description": "Hourly amount; null when the rate has no hourly part.", "type": [ "number", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name", "hourlyAmount", "fixedAmount", "fixedDescription", "currency", "clients" ], "type": "object" }, "type": "array" } }, "required": [ "rates", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List billing rates", "tags": [ "Time and billing" ], "x-required-scope": "billing:read" } }, "/api/actions/cobranza/billing/mark-billing-note-paid": { "post": { "description": "Mark billing note paid\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-mark-billing-note-paid", "requestBody": { "content": { "application/json": { "example": { "args": [ {} ] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark billing note paid", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "billing:write" } }, "/api/actions/cobranza/billing/save-billing-automation": { "post": { "description": "Save billing automation\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-save-billing-automation", "requestBody": { "content": { "application/json": { "example": { "args": [ { "autoIssue": false, "clientId": "", "dayOfMonth": 0, "dayOfWeek": 0, "dueDays": 0, "frequency": "", "rateId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "autoIssue": { "type": "boolean" }, "clientId": { "type": "string" }, "dayOfMonth": { "type": "number" }, "dayOfWeek": { "type": "number" }, "dueDays": { "type": "number" }, "frequency": { "type": "string" }, "rateId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true, "nextRunAt": "2026-01-31T12:00:00Z" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "nextRunAt": { "format": "date-time", "type": "string" }, "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok", "nextRunAt" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save billing automation", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "billing:write" } }, "/api/actions/cobranza/billing/save-billing-bank-account": { "post": { "description": "Save billing bank account\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-save-billing-bank-account", "requestBody": { "content": { "application/json": { "example": { "args": [ {} ] }, "schema": { "properties": { "args": { "items": { "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save billing bank account", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "billing:write" } }, "/api/actions/cobranza/billing/save-billing-rate": { "post": { "description": "Save billing rate\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cobranza-billing-save-billing-rate", "requestBody": { "content": { "application/json": { "example": { "args": [ { "currency": "", "fixedAmount": 0, "fixedDescription": "", "hourlyAmount": 0, "id": "", "name": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "currency": { "type": "string" }, "fixedAmount": { "type": "number" }, "fixedDescription": { "type": "string" }, "hourlyAmount": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"billing:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"billing:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "billing:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save billing rate", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "billing:write" } }, "/api/actions/conversations/moderation/list-case-message-reports": { "post": { "description": "List case message reports\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-conversations-moderation-list-case-message-reports", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caseId": "", "caseType": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caseId": { "type": "string" }, "caseType": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "reports": [ { "id": "string", "messageId": "string", "reason": "string", "details": "string", "status": "string", "createdAt": "2026-01-31T12:00:00Z", "reportedUserId": "string", "reportedUserName": "string", "message": "string", "reporterId": "string", "reporterName": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "reports": { "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "details": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "message": { "type": "string" }, "messageId": { "description": "Chat message id.", "type": "string" }, "reason": { "description": "Why this happened.", "type": "string" }, "reportedUserId": { "type": "string" }, "reportedUserName": { "type": "string" }, "reporterId": { "type": "string" }, "reporterName": { "type": "string" }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "id", "messageId", "reason", "details", "status", "createdAt", "reportedUserId", "reportedUserName", "message", "reporterId", "reporterName" ], "type": "object" }, "type": "array" } }, "required": [ "reports" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List case message reports", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/conversations/moderation/report-case-message": { "post": { "description": "Report case message\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-conversations-moderation-report-case-message", "requestBody": { "content": { "application/json": { "example": { "args": [ { "details": "", "messageId": "", "reason": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "details": { "type": "string" }, "messageId": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "reported": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "reported": { "type": "boolean" } }, "required": [ "reported" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Report case message", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/conversations/moderation/review-case-message-report": { "post": { "description": "Review case message report\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-conversations-moderation-review-case-message-report", "requestBody": { "content": { "application/json": { "example": { "args": [ { "decision": "", "reportId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "decision": { "type": "string" }, "reportId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "reportId": "string", "status": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "reportId": { "type": "string" }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "reportId", "status" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Review case message report", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/conversations/mutations/create-case-message": { "post": { "description": "Create case message\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-conversations-mutations-create-case-message", "requestBody": { "content": { "application/json": { "example": { "args": [ { "body": "", "caseId": "", "caseType": "", "linkedId": "", "linkedKind": "", "mentionedIds": [], "parentMessageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "body": { "type": "string" }, "caseId": { "type": "string" }, "caseType": { "type": "string" }, "linkedId": { "type": "string" }, "linkedKind": { "type": "string" }, "mentionedIds": { "items": { "type": "string" }, "type": "array" }, "parentMessageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create case message", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/conversations/queries/get-case-messages": { "post": { "description": "Get case messages\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-conversations-queries-get-case-messages", "requestBody": { "content": { "application/json": { "example": { "args": [ { "body": "", "caseId": "", "caseType": "", "linkedId": "", "linkedKind": "", "mentionedIds": [], "parentMessageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "body": { "type": "string" }, "caseId": { "type": "string" }, "caseType": { "type": "string" }, "linkedId": { "type": "string" }, "linkedKind": { "type": "string" }, "mentionedIds": { "items": { "type": "string" }, "type": "array" }, "parentMessageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "messages": [ { "id": "string", "authorId": "string", "authorName": "string", "body": "string", "parentMessageId": "string", "mentionedIds": [ "string" ], "createdAt": "2026-01-31T12:00:00Z", "editedAt": "2026-01-31T12:00:00Z", "deleted": true } ], "caseType": "string", "caseId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "caseId": { "description": "Case id; see `caseType` for which kind.", "type": "string" }, "caseType": { "description": "`TRACKED` for a PJUD causa, `INTERNAL` for an expediente.", "type": "string" }, "messages": { "description": "Chat messages, oldest first.", "items": { "properties": { "authorId": { "description": "Id of the user who wrote it.", "type": "string" }, "authorName": { "description": "Name of the user who wrote it.", "type": "string" }, "body": { "description": "Message text.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "deleted": { "description": "Whether the record was deleted.", "type": "boolean" }, "editedAt": { "description": "When it was last edited (ISO 8601); null if never.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "mentionedIds": { "description": "Ids of the users mentioned.", "items": { "type": "string" }, "type": "array" }, "parentMessageId": { "type": [ "string", "null" ] } }, "required": [ "id", "authorId", "authorName", "body", "parentMessageId", "mentionedIds", "createdAt", "editedAt", "deleted" ], "type": "object" }, "type": "array" } }, "required": [ "messages", "caseType", "caseId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get case messages", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/cuentas-provisorias/mutations/run-cuenta-provisoria-cause": { "post": { "description": "Run cuenta provisoria causa\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cuentas-provisorias-mutations-run-cuenta-provisoria-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "taskId": "string", "alreadyQueued": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "alreadyQueued": { "description": "Whether an identical job was already queued.", "type": "boolean" }, "taskId": { "description": "Task id.", "type": "string" } }, "required": [ "taskId", "alreadyQueued" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Run cuenta provisoria causa", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/cuentas-provisorias/mutations/run-cuentas-provisorias-all": { "post": { "description": "Run cuentas provisorias all\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cuentas-provisorias-mutations-run-cuentas-provisorias-all", "requestBody": { "content": { "application/json": { "example": { "args": [ { "dryRun": false, "id": "", "kind": "", "periodo": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "dryRun": { "type": "boolean" }, "id": { "type": "string" }, "kind": { "type": "string" }, "periodo": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "queued": 0, "kind": "string", "periodo": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "kind": { "description": "Record subtype.", "type": "string" }, "periodo": { "type": "string" }, "queued": { "type": "integer" } }, "required": [ "queued", "kind", "periodo" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Run cuentas provisorias all", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/cuentas-provisorias/queries/get-cuenta-provisoria-pdf-url": { "post": { "description": "Get cuenta provisoria pdf url\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cuentas-provisorias-queries-get-cuenta-provisoria-pdf-url", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "previewUrl": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "previewUrl": { "description": "Short-lived URL to preview the file.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url", "previewUrl" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get cuenta provisoria pdf url", "tags": [ "Documents and Drive" ], "x-required-scope": "documents:read" } }, "/api/actions/cuentas-provisorias/queries/get-cuentas-provisorias-cause": { "post": { "description": "Get cuentas provisorias causa\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cuentas-provisorias-queries-get-cuentas-provisorias-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "available": true, "meses": [ { "periodo": "string", "estado": "string", "bcCuentaId": "string", "totIng": 0, "totEgr": 0, "dif": 0, "saldoCtaCte": 0, "inversion": 0, "liquidador": "string", "detalle": null, "pdfPath": "string", "pdfAt": "2026-01-31T12:00:00Z", "pubId": "string", "pubAt": "2026-01-31T12:00:00Z", "syncedAt": "2026-01-31T12:00:00Z" } ], "tareas": [ { "id": "string", "kind": "string", "periodo": "string", "state": "string", "paso": "string", "error": "string", "dryRun": true, "result": null, "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "due": "string", "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "available": { "type": "boolean" }, "canManage": { "type": "boolean" }, "due": { "type": "string" }, "meses": { "items": { "properties": { "bcCuentaId": { "type": [ "string", "null" ] }, "detalle": { "description": "Ingresos, egresos and fondo lines of a finalized month.", "type": "null" }, "dif": { "type": "integer" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "inversion": { "type": "integer" }, "liquidador": { "type": [ "string", "null" ] }, "pdfAt": { "format": "date-time", "type": [ "string", "null" ] }, "pdfPath": { "type": [ "string", "null" ] }, "periodo": { "type": "string" }, "pubAt": { "format": "date-time", "type": [ "string", "null" ] }, "pubId": { "description": "Portal id of the \"Cuenta provisoria del liquidador\" publication covering the month.", "type": [ "string", "null" ] }, "saldoCtaCte": { "type": "integer" }, "syncedAt": { "format": "date-time", "type": [ "string", "null" ] }, "totEgr": { "type": "integer" }, "totIng": { "type": "integer" } }, "required": [ "periodo", "estado", "bcCuentaId", "totIng", "totEgr", "dif", "saldoCtaCte", "inversion", "liquidador", "detalle", "pdfPath", "pdfAt", "pubId", "pubAt", "syncedAt" ], "type": "object" }, "type": "array" }, "tareas": { "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "dryRun": { "type": "boolean" }, "error": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "paso": { "type": [ "string", "null" ] }, "periodo": { "type": "string" }, "result": { "description": "The result.", "type": "null" }, "state": { "description": "Current state.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "kind", "periodo", "state", "paso", "error", "dryRun", "result", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "available", "meses", "tareas" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get cuentas provisorias causa", "tags": [ "Documents and Drive" ], "x-required-scope": "documents:read" } }, "/api/actions/cuentas-provisorias/queries/get-cuentas-provisorias-overview": { "post": { "description": "Get cuentas provisorias overview\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-cuentas-provisorias-queries-get-cuentas-provisorias-overview", "requestBody": { "content": { "application/json": { "example": { "args": [ { "dryRun": false, "id": "", "kind": "", "periodo": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "dryRun": { "type": "boolean" }, "id": { "type": "string" }, "kind": { "type": "string" }, "periodo": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "periodo": "string", "due": "string", "canManage": true, "rows": [ { "id": "string", "rol": "string", "nombre": "string", "tribunal": "string", "documentId": "string", "causaId": "string", "mes": { "estado": "string", "totIng": 0, "totEgr": 0, "dif": 0, "pdf": true, "cuadra": true, "pubId": "string", "pubAt": "string", "syncedAt": "string" }, "bcPub": { "fecha": "string", "estado": "string" }, "ultimoMes": "string", "meses": 0, "tarea": { "id": "string", "kind": "AUTO", "state": "string", "paso": "string", "error": "string", "dryRun": true, "result": { "periodo": "string", "pasos": [ "string" ], "meses": 0, "resultado": 0, "fondoTotal": 0 }, "updatedAt": "string" } } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" }, "due": { "type": "string" }, "periodo": { "type": "string" }, "rows": { "description": "Vigente procedimientos where the org's liquidador is titular.", "items": { "properties": { "bcPub": { "description": "Boletín publication of the periodo's cuenta.", "properties": { "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] } }, "required": [ "fecha", "estado" ], "type": [ "object", "null" ] }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "documentId": { "description": "Document id.", "type": "string" }, "id": { "description": "Procedimiento id.", "type": "string" }, "mes": { "description": "The requested periodo's cuenta, if stored.", "properties": { "cuadra": { "description": "The fondo detail balances with the result.", "type": "boolean" }, "dif": { "description": "Difference, CLP.", "type": "integer" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "pdf": { "description": "A PDF was exported.", "type": "boolean" }, "pubAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "pubId": { "description": "Boletín publication id.", "type": [ "string", "null" ] }, "syncedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "totEgr": { "description": "Total expenses, CLP.", "type": "integer" }, "totIng": { "description": "Total income, CLP.", "type": "integer" } }, "required": [ "estado", "totIng", "totEgr", "dif", "pdf", "cuadra", "pubId", "pubAt", "syncedAt" ], "type": [ "object", "null" ] }, "meses": { "description": "Stored periodos.", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "tarea": { "description": "Latest task of the procedimiento.", "properties": { "dryRun": { "type": "boolean" }, "error": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "enum": [ "AUTO", "SYNC", "PDF", "REPUBLISH" ], "type": "string" }, "paso": { "description": "Last step reached.", "type": [ "string", "null" ] }, "result": { "description": "The result.", "properties": { "fondoTotal": { "type": "integer" }, "meses": { "type": "integer" }, "pasos": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "periodo": { "type": "string" }, "resultado": { "type": "integer" } }, "required": [ "pasos", "meses" ], "type": [ "object", "null" ] }, "state": { "description": "QUEUED, RUNNING, DONE, FAILED or REVISAR.", "type": "string" }, "updatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" } }, "required": [ "id", "kind", "state", "paso", "error", "dryRun", "result", "updatedAt" ], "type": [ "object", "null" ] }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "ultimoMes": { "description": "Latest stored periodo.", "type": [ "string", "null" ] } }, "required": [ "id", "rol", "nombre", "tribunal", "documentId", "causaId", "mes", "bcPub", "ultimoMes", "meses", "tarea" ], "type": "object" }, "type": "array" } }, "required": [ "periodo", "due", "canManage", "rows" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get cuentas provisorias overview", "tags": [ "Documents and Drive" ], "x-required-scope": "documents:read" } }, "/api/actions/custom-attributes/settings/delete-custom-attribute": { "post": { "description": "Delete custom attribute\n\nAuthentication: developer API key. Required scope: `settings:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-custom-attributes-settings-delete-custom-attribute", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"settings:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"settings:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "settings:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete custom attribute", "tags": [ "Other product features" ], "x-modifies-data": true, "x-required-scope": "settings:write" } }, "/api/actions/custom-attributes/settings/get-cause-custom-attributes": { "post": { "description": "Get causa custom attributes\n\nAuthentication: developer API key. Required scope: `settings:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-custom-attributes-settings-get-cause-custom-attributes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "attributes": [ { "id": "string", "entity": "string", "key": "string", "name": "string", "type": "string", "options": [ "string" ], "required": true, "placeholder": "string", "position": 0 } ], "values": { "\u003ckey\u003e": "string" }, "canEdit": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "attributes": { "items": { "properties": { "entity": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "key": { "description": "Stable key.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "options": { "description": "Available options.", "items": { "type": "string" }, "type": "array" }, "placeholder": { "type": "string" }, "position": { "description": "Position in the list.", "type": "integer" }, "required": { "type": "boolean" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "entity", "key", "name", "type", "options", "required", "placeholder", "position" ], "type": "object" }, "type": "array" }, "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "values": { "additionalProperties": { "type": "string" }, "description": "The causa's values keyed by attribute id.", "type": "object" } }, "required": [ "attributes", "values", "canEdit" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"settings:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"settings:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "settings:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get causa custom attributes", "tags": [ "Other product features" ], "x-required-scope": "settings:read" } }, "/api/actions/custom-attributes/settings/list-custom-attributes": { "post": { "description": "List custom attributes\n\nAuthentication: developer API key. Required scope: `settings:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-custom-attributes-settings-list-custom-attributes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "entity": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "entity": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "attributes": [ { "id": "string", "entity": "string", "key": "string", "name": "string", "type": "string", "options": [ "string" ], "required": true, "placeholder": "string", "position": 0 } ], "canEdit": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "attributes": { "items": { "properties": { "entity": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "key": { "description": "Stable key.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "options": { "description": "Available options.", "items": { "type": "string" }, "type": "array" }, "placeholder": { "type": "string" }, "position": { "description": "Position in the list.", "type": "integer" }, "required": { "type": "boolean" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "entity", "key", "name", "type", "options", "required", "placeholder", "position" ], "type": "object" }, "type": "array" }, "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" } }, "required": [ "attributes", "canEdit" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"settings:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"settings:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "settings:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List custom attributes", "tags": [ "Other product features" ], "x-required-scope": "settings:read" } }, "/api/actions/custom-attributes/settings/move-custom-attribute": { "post": { "description": "Move custom attribute\n\nAuthentication: developer API key. Required scope: `settings:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-custom-attributes-settings-move-custom-attribute", "requestBody": { "content": { "application/json": { "example": { "args": [ { "direction": "", "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "direction": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"settings:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"settings:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "settings:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Move custom attribute", "tags": [ "Other product features" ], "x-modifies-data": true, "x-required-scope": "settings:write" } }, "/api/actions/custom-attributes/settings/save-custom-attribute": { "post": { "description": "Save custom attribute\n\nAuthentication: developer API key. Required scope: `settings:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-custom-attributes-settings-save-custom-attribute", "requestBody": { "content": { "application/json": { "example": { "args": [ { "entity": "", "id": "", "name": "", "options": [], "placeholder": "", "required": false, "type": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "entity": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"settings:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"settings:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "settings:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save custom attribute", "tags": [ "Other product features" ], "x-modifies-data": true, "x-required-scope": "settings:write" } }, "/api/actions/custom-attributes/settings/set-cause-custom-attributes": { "post": { "description": "Set causa custom attributes\n\nAuthentication: developer API key. Required scope: `settings:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-custom-attributes-settings-set-cause-custom-attributes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "values": {} } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "values": { "type": "object" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"settings:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"settings:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "settings:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set causa custom attributes", "tags": [ "Other product features" ], "x-modifies-data": true, "x-required-scope": "settings:write" } }, "/api/actions/dashboard/home/get-home-overview": { "post": { "description": "Get home overview\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-dashboard-home-get-home-overview", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "kpis": { "causasTotal": 0, "causasInProgress": 0, "causasStalled": 0, "causasClosed": 0, "tasksOverdue": 0, "tasksToReview": 0, "hearingsNext7Days": 0 }, "attention": { "overdueTasks": [ { "id": "string", "title": "string", "status": "string", "dueDate": "2026-01-31T12:00:00Z" } ], "causaProblems": [ { "id": "string", "rol": "string", "caratulado": "string", "kind": "credential", "detail": "string" } ], "reviewTasks": [ { "id": "string", "title": "string", "status": "string", "dueDate": "2026-01-31T12:00:00Z" } ] }, "recent": [ { "entityType": "CAUSA", "entityId": "string", "viewedAt": "2026-01-31T12:00:00Z", "rol": "string", "caratulado": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "attention": { "properties": { "causaProblems": { "description": "Up to 6 active causas with credential or scrape problems, most recently scraped first.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "detail": { "description": "Scrape error description; may be empty.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "credential: no valid Clave Única; scrape: the last scrape failed.", "enum": [ "credential", "scrape" ], "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "id", "rol", "caratulado", "kind", "detail" ], "type": "object" }, "type": "array" }, "overdueTasks": { "description": "Up to 6 visible open tasks past their due date, the caller's own first.", "items": { "properties": { "dueDate": { "description": "Due date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "status": { "description": "Task status (PENDING, IN_PROGRESS, READY_FOR_REVIEW, ...).", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "status", "dueDate" ], "type": "object" }, "type": "array" }, "reviewTasks": { "description": "Up to 6 tasks waiting for the caller's review, oldest first.", "items": { "properties": { "dueDate": { "description": "Due date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "status": { "description": "Task status (PENDING, IN_PROGRESS, READY_FOR_REVIEW, ...).", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "status", "dueDate" ], "type": "object" }, "type": "array" } }, "required": [ "overdueTasks", "causaProblems", "reviewTasks" ], "type": "object" }, "kpis": { "properties": { "causasClosed": { "type": "integer" }, "causasInProgress": { "type": "integer" }, "causasStalled": { "type": "integer" }, "causasTotal": { "type": "integer" }, "hearingsNext7Days": { "type": "integer" }, "tasksOverdue": { "type": "integer" }, "tasksToReview": { "type": "integer" } }, "required": [ "causasTotal", "causasInProgress", "causasStalled", "causasClosed", "tasksOverdue", "tasksToReview", "hearingsNext7Days" ], "type": "object" }, "recent": { "description": "The caller's last 8 opened causas and expedientes still visible to them.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "entityId": { "type": "string" }, "entityType": { "enum": [ "CAUSA", "INTERNAL_CASE" ], "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "viewedAt": { "format": "date-time", "type": "string" } }, "required": [ "entityType", "entityId", "viewedAt", "rol", "caratulado" ], "type": "object" }, "type": "array" } }, "required": [ "kpis", "attention", "recent" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get home overview", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/dashboard/home/record-recent-view": { "post": { "description": "Record recent view\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-dashboard-home-record-recent-view", "requestBody": { "content": { "application/json": { "example": { "args": [ { "entityId": "", "entityType": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "entityId": { "type": "string" }, "entityType": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "recorded": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "recorded": { "type": "boolean" } }, "required": [ "recorded" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Record recent view", "tags": [ "Other product features" ], "x-modifies-data": true, "x-required-scope": "product:write" } }, "/api/actions/dashboard/preferences/set-dashboard-scope": { "post": { "description": "Set dashboard scope\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-dashboard-preferences-set-dashboard-scope", "requestBody": { "content": { "application/json": { "example": { "args": [ { "defaultOrganization": "", "defaultTeam": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "defaultOrganization": { "type": "string" }, "defaultTeam": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "ok": true, "defaultOrganization": "string", "defaultTeam": "string", "mode": "string", "resolvedOrgIds": [ "string" ], "resolvedTeamId": "string" }, "schema": { "properties": { "defaultOrganization": { "type": "string" }, "defaultTeam": { "type": "string" }, "mode": { "description": "Mode.", "type": "string" }, "ok": { "description": "Whether the action completed.", "type": "boolean" }, "resolvedOrgIds": { "items": { "type": "string" }, "type": "array" }, "resolvedTeamId": { "type": [ "string", "null" ] } }, "required": [ "ok", "defaultOrganization", "defaultTeam", "mode", "resolvedOrgIds", "resolvedTeamId" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set dashboard scope", "tags": [ "Other product features" ], "x-modifies-data": true, "x-required-scope": "product:write" } }, "/api/actions/dashboard/queries/get-client-dashboard-data": { "post": { "description": "Get client dashboard data\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-dashboard-queries-get-client-dashboard-data", "requestBody": { "content": { "application/json": { "example": { "args": [ { "defaultOrganization": "", "defaultTeam": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "defaultOrganization": { "type": "string" }, "defaultTeam": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "scope": { "mode": "string", "defaultOrganization": "string", "defaultTeam": "string", "memberships": 0, "resolvedOrgIds": [ "string" ], "resolvedOrgName": "string", "resolvedTeamId": "string", "resolvedTeamName": "string", "organizations": [ { "id": "string", "name": "string", "active": true, "role": "string", "isPersonal": true, "createdByCurrentUser": true, "hasBillingCard": true, "canManageDeveloperKeys": true, "canInviteUsers": true, "canInviteByRole": true, "canManageTeams": true, "freeTrackedCauseLimit": 0, "freeTrackedCauseCount": 0, "canCreateAnotherOrganization": true, "createBlockedReason": "string", "liquidacionesPublicEnabled": true, "liquidacionesLiquidadorEnabled": true, "exhortoAutoTrackingEnabled": true, "exhortoAutoUntrackOnConclusion": true, "aiAccessEnabled": true, "roleFeatureVisibility": {} } ], "teams": [ { "id": "string", "name": "string", "orgId": "string" } ], "resolvedOrganizationId": "string" }, "orgKpis": { "organizations": 0, "activeOrganizations": 0, "teams": 0, "clients": 0 }, "billingKpis": { "totalInvoices": 0, "openInvoices": 0, "dueSoonInvoices": 0, "overdueInvoices": 0, "lateInvoices": 0, "paidInvoices30d": 0, "paidAmount30d": 0, "financialProfiles": 0, "organizationsWithoutFinancialProfile": 0, "subscriptionMix": { "unitary": 0, "bundle": 0, "fix": 0 }, "invoiceStatusMix": { "pending": 0, "inProgress": 0, "subscriptionPending": 0, "tc1": 0, "tc2": 0, "paid": 0, "late": 0, "error": 0 } }, "emptyState": { "hasAssignments": true, "message": "string" } }, "schema": { "properties": { "billingKpis": { "properties": { "dueSoonInvoices": { "type": "integer" }, "financialProfiles": { "type": "integer" }, "invoiceStatusMix": { "properties": { "error": { "type": "integer" }, "inProgress": { "type": "integer" }, "late": { "type": "integer" }, "paid": { "type": "integer" }, "pending": { "description": "Number pending.", "type": "integer" }, "subscriptionPending": { "type": "integer" }, "tc1": { "type": "integer" }, "tc2": { "type": "integer" } }, "required": [ "pending", "inProgress", "subscriptionPending", "tc1", "tc2", "paid", "late", "error" ], "type": "object" }, "lateInvoices": { "type": "integer" }, "openInvoices": { "type": "integer" }, "organizationsWithoutFinancialProfile": { "type": "integer" }, "overdueInvoices": { "type": "integer" }, "paidAmount30d": { "type": "integer" }, "paidInvoices30d": { "type": "integer" }, "subscriptionMix": { "properties": { "bundle": { "type": "integer" }, "fix": { "type": "integer" }, "unitary": { "type": "integer" } }, "required": [ "unitary", "bundle", "fix" ], "type": "object" }, "totalInvoices": { "type": "integer" } }, "required": [ "totalInvoices", "openInvoices", "dueSoonInvoices", "overdueInvoices", "lateInvoices", "paidInvoices30d", "paidAmount30d", "financialProfiles", "organizationsWithoutFinancialProfile", "subscriptionMix", "invoiceStatusMix" ], "type": "object" }, "emptyState": { "properties": { "hasAssignments": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "hasAssignments", "message" ], "type": "object" }, "orgKpis": { "properties": { "activeOrganizations": { "type": "integer" }, "clients": { "description": "Clients linked to the record.", "type": "integer" }, "organizations": { "description": "Organizations.", "type": "integer" }, "teams": { "description": "Teams.", "type": "integer" } }, "required": [ "organizations", "activeOrganizations", "teams", "clients" ], "type": "object" }, "scope": { "properties": { "defaultOrganization": { "type": "string" }, "defaultTeam": { "type": "string" }, "memberships": { "type": "integer" }, "mode": { "description": "Mode.", "type": "string" }, "organizations": { "description": "Organizations.", "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "aiAccessEnabled": { "description": "Whether AI features may read this causa.", "type": "boolean" }, "canCreateAnotherOrganization": { "type": "boolean" }, "canInviteByRole": { "type": "boolean" }, "canInviteUsers": { "type": "boolean" }, "canManageDeveloperKeys": { "type": "boolean" }, "canManageTeams": { "type": "boolean" }, "createBlockedReason": { "type": "string" }, "createdByCurrentUser": { "type": "boolean" }, "exhortoAutoTrackingEnabled": { "type": "boolean" }, "exhortoAutoUntrackOnConclusion": { "type": "boolean" }, "freeTrackedCauseCount": { "type": "integer" }, "freeTrackedCauseLimit": { "type": "integer" }, "hasBillingCard": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "isPersonal": { "type": "boolean" }, "liquidacionesLiquidadorEnabled": { "type": "boolean" }, "liquidacionesPublicEnabled": { "type": "boolean" }, "name": { "description": "Display name.", "type": "string" }, "role": { "description": "Role.", "type": "string" }, "roleFeatureVisibility": { "description": "Legacy per-role navigation visibility: an object keyed by role whose values are arrays of visible feature keys; null when the organization never configured it." } }, "required": [ "id", "name", "active", "role", "isPersonal", "createdByCurrentUser", "hasBillingCard", "canManageDeveloperKeys", "canInviteUsers", "canInviteByRole", "canManageTeams", "freeTrackedCauseLimit", "freeTrackedCauseCount", "canCreateAnotherOrganization", "createBlockedReason", "liquidacionesPublicEnabled", "liquidacionesLiquidadorEnabled", "exhortoAutoTrackingEnabled", "exhortoAutoUntrackOnConclusion", "aiAccessEnabled", "roleFeatureVisibility" ], "type": "object" }, "type": "array" }, "resolvedOrgIds": { "items": { "type": "string" }, "type": "array" }, "resolvedOrgName": { "type": [ "string", "null" ] }, "resolvedOrganizationId": { "description": "Organization the request was resolved against.", "type": [ "string", "null" ] }, "resolvedTeamId": { "type": [ "string", "null" ] }, "resolvedTeamName": { "type": [ "string", "null" ] }, "teams": { "description": "Teams.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" } }, "required": [ "id", "name", "orgId" ], "type": "object" }, "type": "array" } }, "required": [ "mode", "defaultOrganization", "defaultTeam", "memberships", "resolvedOrgIds", "resolvedOrgName", "resolvedTeamId", "resolvedTeamName", "organizations", "teams" ], "type": "object" } }, "required": [ "scope", "orgKpis", "billingKpis", "emptyState" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get client dashboard data", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/dashboard/queries/get-dashboard-scope-options": { "post": { "description": "Get dashboard scope options\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-dashboard-queries-get-dashboard-scope-options", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "defaultOrganization": "string", "defaultTeam": "string", "mode": "string", "organizations": [ { "id": "string", "name": "string", "active": true, "role": "string", "isPersonal": true, "createdByCurrentUser": true, "hasBillingCard": true, "canManageDeveloperKeys": true, "canInviteUsers": true, "canInviteByRole": true, "canManageTeams": true, "freeTrackedCauseLimit": 0, "freeTrackedCauseCount": 0, "canCreateAnotherOrganization": true, "createBlockedReason": "string", "liquidacionesPublicEnabled": true, "liquidacionesLiquidadorEnabled": true, "exhortoAutoTrackingEnabled": true, "exhortoAutoUntrackOnConclusion": true, "aiAccessEnabled": true, "roleFeatureVisibility": {} } ], "teams": [ { "id": "string", "name": "string", "orgId": "string" } ], "allTeams": [ { "id": "string", "name": "string", "orgId": "string" } ], "resolvedOrganizationId": "string", "resolvedOrganizationName": "string", "resolvedTeamId": "string", "hasDeveloperKeyAccess": true, "forcedByDomain": true, "creation": { "createdOrganizationCount": 0, "hasPersonalOrganization": true, "billingUnlocked": true, "canCreateAnotherOrganization": true, "canCreatePersonalOrganization": true, "createBlockedReason": "string" } }, "schema": { "properties": { "allTeams": { "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" } }, "required": [ "id", "name", "orgId" ], "type": "object" }, "type": "array" }, "creation": { "properties": { "billingUnlocked": { "type": "boolean" }, "canCreateAnotherOrganization": { "type": "boolean" }, "canCreatePersonalOrganization": { "type": "boolean" }, "createBlockedReason": { "type": "string" }, "createdOrganizationCount": { "type": "integer" }, "hasPersonalOrganization": { "type": "boolean" } }, "required": [ "createdOrganizationCount", "hasPersonalOrganization", "billingUnlocked", "canCreateAnotherOrganization", "canCreatePersonalOrganization", "createBlockedReason" ], "type": "object" }, "defaultOrganization": { "type": "string" }, "defaultTeam": { "type": "string" }, "forcedByDomain": { "type": "boolean" }, "hasDeveloperKeyAccess": { "type": "boolean" }, "mode": { "description": "Mode.", "type": "string" }, "organizations": { "description": "Organizations.", "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "aiAccessEnabled": { "description": "Whether AI features may read this causa.", "type": "boolean" }, "canCreateAnotherOrganization": { "type": "boolean" }, "canInviteByRole": { "type": "boolean" }, "canInviteUsers": { "type": "boolean" }, "canManageDeveloperKeys": { "type": "boolean" }, "canManageTeams": { "type": "boolean" }, "createBlockedReason": { "type": "string" }, "createdByCurrentUser": { "type": "boolean" }, "exhortoAutoTrackingEnabled": { "type": "boolean" }, "exhortoAutoUntrackOnConclusion": { "type": "boolean" }, "freeTrackedCauseCount": { "type": "integer" }, "freeTrackedCauseLimit": { "type": "integer" }, "hasBillingCard": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "isPersonal": { "type": "boolean" }, "liquidacionesLiquidadorEnabled": { "type": "boolean" }, "liquidacionesPublicEnabled": { "type": "boolean" }, "name": { "description": "Display name.", "type": "string" }, "role": { "description": "Role.", "type": "string" }, "roleFeatureVisibility": { "description": "Legacy per-role navigation visibility: an object keyed by role whose values are arrays of visible feature keys; null when the organization never configured it." } }, "required": [ "id", "name", "active", "role", "isPersonal", "createdByCurrentUser", "hasBillingCard", "canManageDeveloperKeys", "canInviteUsers", "canInviteByRole", "canManageTeams", "freeTrackedCauseLimit", "freeTrackedCauseCount", "canCreateAnotherOrganization", "createBlockedReason", "liquidacionesPublicEnabled", "liquidacionesLiquidadorEnabled", "exhortoAutoTrackingEnabled", "exhortoAutoUntrackOnConclusion", "aiAccessEnabled", "roleFeatureVisibility" ], "type": "object" }, "type": "array" }, "resolvedOrganizationId": { "description": "Organization the request was resolved against.", "type": [ "string", "null" ] }, "resolvedOrganizationName": { "type": [ "string", "null" ] }, "resolvedTeamId": { "type": [ "string", "null" ] }, "teams": { "description": "Teams.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" } }, "required": [ "id", "name", "orgId" ], "type": "object" }, "type": "array" } }, "required": [ "defaultOrganization", "defaultTeam", "mode", "organizations", "teams", "allTeams", "resolvedOrganizationId", "resolvedOrganizationName", "resolvedTeamId", "hasDeveloperKeyAccess", "forcedByDomain", "creation" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get dashboard scope options", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/deadlines/compute-deadline": { "post": { "description": "Compute a procedural deadline (business days, Chilean holidays).\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-deadlines-compute-deadline", "requestBody": { "content": { "application/json": { "example": { "args": [ { "days": 0, "locality": "", "mode": "", "procedure": "", "startDate": "", "template": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "days": { "type": "number" }, "locality": { "type": "string" }, "mode": { "type": "string" }, "procedure": { "type": "string" }, "startDate": { "type": "string" }, "template": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "dueDate": "string", "counted": 0, "excluded": [ { "date": "string", "reason": "string" } ], "mode": "string", "days": 0, "sources": [ { "title": "string", "url": "string" } ], "calendarCoverage": "string", "warnings": [ "string" ], "rule": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "calendarCoverage": { "type": "string" }, "counted": { "type": "integer" }, "days": { "description": "Number of days.", "type": "integer" }, "dueDate": { "description": "Due date (ISO 8601).", "type": "string" }, "excluded": { "items": { "properties": { "date": { "description": "Date (ISO 8601).", "type": "string" }, "reason": { "description": "Why this happened.", "type": "string" } }, "required": [ "date", "reason" ], "type": "object" }, "type": "array" }, "mode": { "description": "Mode.", "type": "string" }, "rule": { "type": "string" }, "sources": { "items": { "properties": { "title": { "description": "Title.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "title", "url" ], "type": "object" }, "type": "array" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "dueDate", "counted", "excluded", "mode", "days", "sources", "calendarCoverage", "warnings", "rule" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reference:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reference:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reference:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Compute deadline", "tags": [ "Expedientes and activity" ], "x-required-scope": "reference:read" } }, "/api/actions/deudores/mutations/save-deudor-sii": { "post": { "description": "Save deudor sii\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-deudores-mutations-save-deudor-sii", "requestBody": { "content": { "application/json": { "example": { "args": [ { "nombre": "", "note": "", "password": "", "rut": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "nombre": { "type": "string" }, "note": { "type": "string" }, "password": { "type": "string" }, "rut": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rut": "string", "hasCredential": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "hasCredential": { "description": "Whether a PJUD credential (Clave Única or Poder Judicial) is stored.", "type": "boolean" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" } }, "required": [ "rut", "hasCredential" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save deudor sii", "tags": [ "Other product features" ], "x-modifies-data": true, "x-required-scope": "product:write" } }, "/api/actions/deudores/queries/get-deudor-sii": { "post": { "description": "Get deudor sii\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-deudores-queries-get-deudor-sii", "requestBody": { "content": { "application/json": { "example": { "args": [ { "rut": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "rut": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rut": "string", "canWrite": true, "hasCredential": true, "nombre": "string", "publishedName": "string", "note": "string", "statusCheck": "string", "lastCheck": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canWrite": { "type": "boolean" }, "hasCredential": { "description": "Whether a PJUD credential (Clave Única or Poder Judicial) is stored.", "type": "boolean" }, "lastCheck": { "description": "Last time access was checked (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "nombre": { "description": "Display name.", "type": "string" }, "note": { "description": "Free-text note.", "type": "string" }, "publishedName": { "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "statusCheck": { "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "rut", "canWrite", "hasCredential", "nombre", "publishedName", "note", "statusCheck", "lastCheck", "updatedAt" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get deudor sii", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/deudores/queries/get-deudores-summary": { "post": { "description": "Get deudores summary\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-deudores-queries-get-deudores-summary", "requestBody": { "content": { "application/json": { "example": { "args": [ { "estado": "", "page": 0, "perPage": 0, "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "estado": { "type": "string" }, "page": { "type": "number" }, "perPage": { "type": "number" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "deudores": [ { "key": "string", "rut": "string", "rutRaw": "string", "nombre": "string", "estado": "string", "active": true, "procedimientos": 0, "assignees": [ "string" ], "creditos": 0, "creditosPorVerificar": 0, "bienes": 0, "bienesPorVerificar": 0, "bienesConAvaluoFiscal": 0, "hasSii": true, "siiStatus": "OK", "siiLastCheck": "string", "siiUpdatedAt": "string" } ], "total": 0, "page": 0, "perPage": 0, "estado": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "deudores": { "description": "Debtors.", "items": { "properties": { "active": { "description": "Has a procedimiento not TERMINADO / FINALIZADO.", "type": "boolean" }, "assignees": { "description": "Names of the assigned org members.", "items": { "type": "string" }, "type": "array" }, "bienes": { "type": "integer" }, "bienesConAvaluoFiscal": { "type": "integer" }, "bienesPorVerificar": { "type": "integer" }, "creditos": { "type": "integer" }, "creditosPorVerificar": { "type": "integer" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "hasSii": { "description": "An SII credential is stored.", "type": "boolean" }, "key": { "description": "Normalized RUT, or doc:\u003cprocedimiento id\u003e when the RUT is unknown.", "type": "string" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "procedimientos": { "type": "integer" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "rutRaw": { "description": "RUT as published.", "type": [ "string", "null" ] }, "siiLastCheck": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "siiStatus": { "enum": [ "OK", "ERROR", "INCORRECT", "BLOCKED" ], "type": [ "string", "null" ] }, "siiUpdatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] } }, "required": [ "key", "rut", "rutRaw", "nombre", "estado", "active", "procedimientos", "assignees", "creditos", "creditosPorVerificar", "bienes", "bienesPorVerificar", "bienesConAvaluoFiscal", "hasSii", "siiStatus", "siiLastCheck", "siiUpdatedAt" ], "type": "object" }, "type": "array" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "page": { "description": "Current page number (1-based).", "type": "integer" }, "perPage": { "description": "Page size.", "type": "integer" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "deudores", "total", "page", "perPage", "estado" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get deudores summary", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/drive/assistant/save-assistant-message-to-drive": { "post": { "description": "Save assistant message to drive\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-assistant-save-assistant-message-to-drive", "requestBody": { "content": { "application/json": { "example": { "args": [ { "folderId": "", "messageId": "", "name": "", "scope": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "folderId": { "type": "string" }, "messageId": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "name": "string", "caseLabel": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "caseLabel": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name", "caseLabel" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save assistant message to drive", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/docs/add-drive-comment": { "post": { "description": "Add drive comment\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-docs-add-drive-comment", "requestBody": { "content": { "application/json": { "example": { "args": [ { "body": "", "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "body": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add drive comment", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/docs/create-drive-document": { "post": { "description": "Create drive document\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-docs-create-drive-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "docxBase64": "", "folderId": "", "html": "", "name": "", "scope": "", "templateId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "docxBase64": { "type": "string" }, "folderId": { "type": "string" }, "html": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" }, "templateId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create drive document", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/docs/get-drive-document": { "post": { "description": "Get drive document\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-docs-get-drive-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "file": { "id": "string", "name": "string", "kind": "FILE", "mime": "string", "size": 0, "version": 0, "personal": true, "folderId": "string", "updatedAt": "2026-01-31T12:00:00Z", "deletedAt": "2026-01-31T12:00:00Z", "reviewStatus": "string", "reviewerId": "string", "reviewerName": "string", "reviewComment": "string", "causaId": "string", "causaRol": "string", "internalCauseId": "string", "taskId": "string", "taskTitle": "string", "updatedBy": "string", "teamId": "string", "teamName": "string", "sharedTeamIds": [ "string" ], "ownerName": "string" }, "html": "string", "rev": 0, "viewers": [ { "userId": "string", "name": "string", "me": true } ], "comments": [ { "id": "string", "author": "string", "body": "string", "createdAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "comments": { "description": "Comments, oldest first (up to 300).", "items": { "properties": { "author": { "description": "Author name.", "type": "string" }, "body": { "description": "Message text.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id", "author", "body", "createdAt" ], "type": "object" }, "type": "array" }, "file": { "properties": { "causaId": { "description": "Linked causa; empty when none.", "type": "string" }, "causaRol": { "type": "string" }, "deletedAt": { "description": "Set while in the trash.", "format": "date-time", "type": [ "string", "null" ] }, "folderId": { "description": "Empty at the top of a drive.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "internalCauseId": { "description": "Linked expediente; empty when none.", "type": "string" }, "kind": { "description": "Record subtype.", "enum": [ "FILE", "DOC" ], "type": "string" }, "mime": { "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "ownerName": { "description": "Name of the creator.", "type": "string" }, "personal": { "description": "Whether it lives in someone's personal drive.", "type": "boolean" }, "reviewComment": { "type": "string" }, "reviewStatus": { "description": "Review state; empty when no review was requested.", "type": "string" }, "reviewerId": { "type": "string" }, "reviewerName": { "type": "string" }, "sharedTeamIds": { "items": { "type": "string" }, "type": "array" }, "size": { "description": "Bytes.", "type": "integer" }, "taskId": { "description": "Linked task; empty when none.", "type": "string" }, "taskTitle": { "type": "string" }, "teamId": { "description": "Team drive; empty when none.", "type": "string" }, "teamName": { "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "updatedBy": { "description": "Name of the last editor.", "type": "string" }, "version": { "description": "Current version number.", "type": "integer" } }, "required": [ "id", "name", "kind", "mime", "size", "version", "personal", "folderId", "updatedAt", "deletedAt", "reviewStatus", "reviewerId", "reviewerName", "reviewComment", "causaId", "causaRol", "internalCauseId", "taskId", "taskTitle", "updatedBy", "teamId", "teamName", "sharedTeamIds", "ownerName" ], "type": "object" }, "html": { "type": "string" }, "rev": { "type": "integer" }, "viewers": { "description": "Users who had the document open in the presence window.", "items": { "properties": { "me": { "description": "Whether it is the caller.", "type": "boolean" }, "name": { "description": "Display name.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "me" ], "type": "object" }, "type": "array" } }, "required": [ "file", "html", "rev", "viewers", "comments" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get drive document", "tags": [ "Documents and Drive" ], "x-required-scope": "documents:read" } }, "/api/actions/drive/docs/ping-drive-document": { "post": { "description": "Ping drive document\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-docs-ping-drive-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rev": 0, "viewers": [ { "userId": "string", "name": "string", "me": true } ], "comments": [ { "id": "string", "author": "string", "body": "string", "createdAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "comments": { "description": "Comments, oldest first (up to 300).", "items": { "properties": { "author": { "description": "Author name.", "type": "string" }, "body": { "description": "Message text.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id", "author", "body", "createdAt" ], "type": "object" }, "type": "array" }, "rev": { "type": "integer" }, "viewers": { "description": "Users who had the document open in the presence window.", "items": { "properties": { "me": { "description": "Whether it is the caller.", "type": "boolean" }, "name": { "description": "Display name.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "me" ], "type": "object" }, "type": "array" } }, "required": [ "rev", "viewers", "comments" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Ping drive document", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/docs/save-drive-document": { "post": { "description": "Save drive document\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-docs-save-drive-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "baseHtml": "", "html": "", "id": "", "rev": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "baseHtml": { "type": "string" }, "html": { "type": "string" }, "id": { "type": "string" }, "rev": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "stale": true, "rev": 0, "conflict": true, "theirs": "string", "mine": "string", "merged": true, "html": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "conflict": { "type": "boolean" }, "html": { "type": "string" }, "merged": { "type": "boolean" }, "mine": { "description": "Whether it belongs to the API key's acting user.", "type": "string" }, "rev": { "type": "integer" }, "stale": { "type": "boolean" }, "theirs": { "type": "string" } }, "required": [ "rev" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save drive document", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/create-drive-folder": { "post": { "description": "Create drive folder\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-create-drive-folder", "requestBody": { "content": { "application/json": { "example": { "args": [ { "confirm": false, "folderId": "", "id": "", "kind": "", "name": "", "scope": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "confirm": { "type": "boolean" }, "folderId": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create drive folder", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/decide-drive-review": { "post": { "description": "Decide drive review\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-decide-drive-review", "requestBody": { "content": { "application/json": { "example": { "args": [ { "approve": false, "comment": "", "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "approve": { "type": "boolean" }, "comment": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Decide drive review", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/get-drive-file-url": { "post": { "description": "Get drive file url\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-get-drive-file-url", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "version": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "version": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "name": "string", "contentBase64": "string", "mime": "string", "url": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "contentBase64": { "type": "string" }, "mime": { "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "name" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get drive file url", "tags": [ "Documents and Drive" ], "x-required-scope": "documents:read" } }, "/api/actions/drive/files/get-drive-pickers": { "post": { "description": "Get drive pickers\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-get-drive-pickers", "requestBody": { "content": { "application/json": { "example": { "args": [ {} ] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "folders": [ { "id": "string", "label": "string" } ], "causas": [ { "id": "string", "label": "string" } ], "internalCases": [ { "id": "string", "label": "string" } ], "tasks": [ { "id": "string", "label": "string" } ], "members": [ { "id": "string", "label": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causas": { "description": "Organization causas (latest 400); label is \"rol · carátula\".", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "folders": { "description": "Visible folders (up to 1000); label is the full path.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "internalCases": { "description": "Expedientes (latest 300); label is \"rol · name\".", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "members": { "description": "Organization members; label is the name or email.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "tasks": { "description": "Tasks (latest 300); label is the title.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" } }, "required": [ "folders", "causas", "internalCases", "tasks", "members" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get drive pickers", "tags": [ "Documents and Drive" ], "x-required-scope": "documents:read" } }, "/api/actions/drive/files/link-drive-file": { "post": { "description": "Link drive file\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-link-drive-file", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "id": "", "internalCauseId": "", "taskId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "id": { "type": "string" }, "internalCauseId": { "type": "string" }, "taskId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Link drive file", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/list-drive": { "post": { "description": "List drive\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-list-drive", "requestBody": { "content": { "application/json": { "example": { "args": [ { "folderId": "", "internalCauseId": "", "q": "", "teamId": "", "view": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "folderId": { "type": "string" }, "internalCauseId": { "type": "string" }, "q": { "type": "string" }, "teamId": { "type": "string" }, "view": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "folders": [ { "id": "string", "name": "string", "kind": "branch", "source": "string", "parentId": "string", "personal": true, "teamId": "string", "teamName": "string", "sharedTeamIds": [ "string" ], "ownerName": "string", "deletedAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "files": [ { "id": "string", "name": "string", "kind": "FILE", "mime": "string", "size": 0, "version": 0, "personal": true, "folderId": "string", "updatedAt": "2026-01-31T12:00:00Z", "deletedAt": "2026-01-31T12:00:00Z", "reviewStatus": "string", "reviewerId": "string", "reviewerName": "string", "reviewComment": "string", "causaId": "string", "causaRol": "string", "internalCauseId": "string", "taskId": "string", "taskTitle": "string", "updatedBy": "string", "teamId": "string", "teamName": "string", "sharedTeamIds": [ "string" ], "ownerName": "string", "source": "string", "targetId": "string", "date": "string", "path": "string", "documentId": "string" } ], "breadcrumbs": [ { "id": "string", "name": "string" } ], "usedBytes": 0, "quotaBytes": 0, "teams": [ { "id": "string", "name": "string", "member": true } ], "expedientes": [ { "id": "string", "name": "string", "rol": "string", "clientName": "string", "archived": true, "updatedAt": "2026-01-31T12:00:00Z", "documentCount": 0 } ], "expediente": { "id": "string", "name": "string", "rol": "string", "canEdit": true, "readOnly": true, "relatedCauseId": "string", "folderId": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "breadcrumbs": { "description": "Folder chain from the top down to the listed folder.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "type": "array" }, "expediente": { "description": "View expediente only: the expediente and location listed.", "properties": { "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "folderId": { "description": "Expediente folder listed; empty when none.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "readOnly": { "description": "True for a linked causa's source documents.", "type": "boolean" }, "relatedCauseId": { "description": "Linked causa of the location; empty at the top.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "id", "name", "rol", "canEdit", "readOnly", "relatedCauseId", "folderId" ], "type": "object" }, "expedientes": { "description": "View expedientes only: visible expedientes (up to 500).", "items": { "properties": { "archived": { "description": "Whether the record is archived.", "type": "boolean" }, "clientName": { "type": "string" }, "documentCount": { "description": "Number of documents.", "type": "integer" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "rol", "clientName", "archived", "updatedAt", "documentCount" ], "type": "object" }, "type": "array" }, "files": { "description": "Files of the location (up to 500). Drive views return full Drive file rows; expediente documents and causa source documents carry a subset plus source/targetId.", "items": { "properties": { "causaId": { "description": "Linked causa; empty when none.", "type": "string" }, "causaRol": { "type": "string" }, "date": { "description": "Source documents: the source's date, as text.", "type": [ "string", "null" ] }, "deletedAt": { "description": "Set while in the trash.", "format": "date-time", "type": [ "string", "null" ] }, "documentId": { "description": "Source documents: portal document id (TC/TCP).", "type": [ "string", "null" ] }, "folderId": { "description": "Empty at the top of a drive.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "internalCauseId": { "description": "Linked expediente; empty when none.", "type": "string" }, "kind": { "description": "FILE or DOC; FILE for expediente and source documents.", "enum": [ "FILE", "DOC" ], "type": "string" }, "mime": { "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "ownerName": { "description": "Name of the creator.", "type": "string" }, "path": { "description": "Source documents: storage path.", "type": [ "string", "null" ] }, "personal": { "description": "Whether it lives in someone's personal drive.", "type": "boolean" }, "reviewComment": { "type": "string" }, "reviewStatus": { "description": "Review state; empty when no review was requested.", "type": "string" }, "reviewerId": { "type": "string" }, "reviewerName": { "type": "string" }, "sharedTeamIds": { "items": { "type": "string" }, "type": "array" }, "size": { "description": "Bytes.", "type": "integer" }, "source": { "description": "Expediente view: drive (a Drive file linked to the expediente), exp (an expediente document), or the lowercase source of a causa document (ojv, bc, tc, tcp, tta).", "type": "string" }, "targetId": { "description": "Expediente view: the expediente (exp) or source causa the document belongs to.", "type": "string" }, "taskId": { "description": "Linked task; empty when none.", "type": "string" }, "taskTitle": { "type": "string" }, "teamId": { "description": "Team drive; empty when none.", "type": "string" }, "teamName": { "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "updatedBy": { "description": "Name of the last editor.", "type": "string" }, "version": { "description": "Current version number.", "type": "integer" } }, "required": [ "id", "name", "kind", "mime" ], "type": "object" }, "type": "array" }, "folders": { "description": "Folders of the location (up to 500). Drive views return Drive folders; the expediente view returns linked causas and expediente folders.", "items": { "properties": { "deletedAt": { "description": "When the record was deleted (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Folder id; in the expediente view also rc:\u003crelatedCauseId\u003e (a linked causa) or src:\u003crelatedCauseId\u003e (its source documents).", "type": "string" }, "kind": { "description": "Expediente view only.", "enum": [ "branch", "source", "folder" ], "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "ownerName": { "description": "Name of the creator.", "type": "string" }, "parentId": { "description": "Drive views: empty at the top of a drive.", "type": "string" }, "personal": { "type": "boolean" }, "sharedTeamIds": { "items": { "type": "string" }, "type": "array" }, "source": { "description": "Expediente view, kind branch: the linked causa's source (OJV, BC, TC, TCP, TTA).", "type": "string" }, "teamId": { "type": "string" }, "teamName": { "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "type": "array" }, "quotaBytes": { "type": "integer" }, "teams": { "description": "Teams.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "member": { "type": "boolean" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name", "member" ], "type": "object" }, "type": "array" }, "usedBytes": { "type": "integer" } }, "required": [ "folders", "files", "breadcrumbs", "usedBytes", "quotaBytes", "teams" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List drive", "tags": [ "Documents and Drive" ], "x-required-scope": "documents:read" } }, "/api/actions/drive/files/list-drive-versions": { "post": { "description": "List drive versions\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-list-drive-versions", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "versions": [ { "version": 0, "name": "string", "size": 0, "createdAt": "2026-01-31T12:00:00Z", "createdBy": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "versions": { "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdBy": { "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "size": { "type": "integer" }, "version": { "type": "integer" } }, "required": [ "version", "name", "size", "createdAt", "createdBy" ], "type": "object" }, "type": "array" } }, "required": [ "versions" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List drive versions", "tags": [ "Documents and Drive" ], "x-required-scope": "documents:read" } }, "/api/actions/drive/files/move-drive-item": { "post": { "description": "Move drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-move-drive-item", "requestBody": { "content": { "application/json": { "example": { "args": [ { "confirm": false, "folderId": "", "id": "", "kind": "", "name": "", "scope": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "confirm": { "type": "boolean" }, "folderId": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Move drive item", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/purge-drive-item": { "post": { "description": "Purge drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-purge-drive-item", "requestBody": { "content": { "application/json": { "example": { "args": [ { "confirm": false, "folderId": "", "id": "", "kind": "", "name": "", "scope": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "confirm": { "type": "boolean" }, "folderId": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Purge drive item", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/rename-drive-item": { "post": { "description": "Rename drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-rename-drive-item", "requestBody": { "content": { "application/json": { "example": { "args": [ { "confirm": false, "folderId": "", "id": "", "kind": "", "name": "", "scope": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "confirm": { "type": "boolean" }, "folderId": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Rename drive item", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/request-drive-review": { "post": { "description": "Request drive review\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-request-drive-review", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "reviewerId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "reviewerId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Request drive review", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/restore-drive-item": { "post": { "description": "Restore drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-restore-drive-item", "requestBody": { "content": { "application/json": { "example": { "args": [ { "confirm": false, "folderId": "", "id": "", "kind": "", "name": "", "scope": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "confirm": { "type": "boolean" }, "folderId": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Restore drive item", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/restore-drive-version": { "post": { "description": "Restore drive version\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-restore-drive-version", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "version": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "version": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "version": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "version": { "type": "integer" } }, "required": [ "version" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Restore drive version", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/share-drive-item": { "post": { "description": "Share drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-share-drive-item", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "kind": "", "teamIds": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "teamIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "sharedTeamIds": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "sharedTeamIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "sharedTeamIds" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Share drive item", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/trash-drive-item": { "post": { "description": "Trash drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-trash-drive-item", "requestBody": { "content": { "application/json": { "example": { "args": [ { "confirm": false, "folderId": "", "id": "", "kind": "", "name": "", "scope": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "confirm": { "type": "boolean" }, "folderId": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Trash drive item", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/files/upload-drive-file": { "post": { "description": "Upload drive file\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-files-upload-drive-file", "requestBody": { "content": { "application/json": { "example": { "args": [ { "contentBase64": "", "fileId": "", "folderId": "", "name": "", "scope": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "contentBase64": { "type": "string" }, "fileId": { "type": "string" }, "folderId": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "version": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "version": { "type": "integer" } }, "required": [ "id", "version" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload drive file", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/templates/delete-drive-template": { "post": { "description": "Delete drive template\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-templates-delete-drive-template", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": null }, "schema": { "properties": { "data": { "description": "The action's result.", "type": "null" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete drive template", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/drive/templates/list-drive-templates": { "post": { "description": "List drive templates\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-templates-list-drive-templates", "requestBody": { "content": { "application/json": { "example": { "args": [ {} ] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "templates": [ { "id": "string", "name": "string", "html": "string", "updatedAt": "2026-01-31T12:00:00Z" } ], "variables": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "templates": { "items": { "properties": { "html": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "html", "updatedAt" ], "type": "object" }, "type": "array" }, "variables": { "items": { "type": "string" }, "type": "array" } }, "required": [ "templates", "variables" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List drive templates", "tags": [ "Documents and Drive" ], "x-required-scope": "documents:read" } }, "/api/actions/drive/templates/save-drive-template": { "post": { "description": "Save drive template\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-drive-templates-save-drive-template", "requestBody": { "content": { "application/json": { "example": { "args": [ { "html": "", "id": "", "name": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "html": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save drive template", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/expedientes/workspace/execute-expediente": { "post": { "description": "Execute expediente\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-expedientes-workspace-execute-expediente", "requestBody": { "content": { "application/json": { "example": { "args": [ { "assignedUserIds": [], "cause": {}, "causes": [], "clientName": "", "creationKey": "", "dataBase64": "", "description": "", "documentId": "", "folderId": "", "id": "", "mimeType": "", "name": "", "operation": "", "orgId": "", "preserveDocuments": false, "reference": "", "relatedCauseId": "", "teamIds": [], "uploadKey": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "assignedUserIds": { "items": { "type": "string" }, "type": "array" }, "cause": { "type": "object" }, "causes": { "items": { "type": "object" }, "type": "array" }, "clientName": { "type": "string" }, "creationKey": { "type": "string" }, "dataBase64": { "type": "string" }, "description": { "type": "string" }, "documentId": { "type": "string" }, "folderId": { "type": "string" }, "id": { "type": "string" }, "mimeType": { "type": "string" }, "name": { "type": "string" }, "operation": { "type": "string" }, "orgId": { "type": "string" }, "preserveDocuments": { "type": "boolean" }, "reference": { "type": "string" }, "relatedCauseId": { "type": "string" }, "teamIds": { "items": { "type": "string" }, "type": "array" }, "uploadKey": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true, "id": "string", "url": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "success": { "description": "Whether the operation succeeded.", "type": "boolean" }, "url": { "description": "Absolute URL.", "type": "string" } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Execute expediente", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/expedientes/workspace/get-expediente-feed": { "post": { "description": "Get expediente feed\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-expedientes-workspace-get-expediente-feed", "requestBody": { "content": { "application/json": { "example": { "args": [ { "category": "", "cause": "", "documents": false, "id": "", "page": 0, "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "category": { "type": "string" }, "cause": { "type": "string" }, "documents": { "type": "boolean" }, "id": { "type": "string" }, "page": { "type": "number" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "id": "string", "relatedCauseId": "string", "source": "OJV", "targetId": "string", "title": "string", "date": "string", "path": "string", "documentId": "string", "detail": {}, "total": 0 } ], "total": 0, "pageCount": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "rows": { "description": "The records on this page.", "items": { "properties": { "date": { "description": "Event date as stored by the source, as text (Postgres timestamp text or the portal's date); may be empty.", "type": [ "string", "null" ] }, "detail": { "description": "Extra detail of a Boletín publication (its remate data, as scraped); null otherwise." }, "documentId": { "description": "Portal document id (TC/TCP), when it has one.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "path": { "description": "Storage path of the event's document, when it has one.", "type": [ "string", "null" ] }, "relatedCauseId": { "description": "Expediente link (branch) the event comes from; null for expediente-level events.", "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "enum": [ "OJV", "BC", "TC", "TCP", "TTA", "INTERNAL" ], "type": "string" }, "targetId": { "description": "Id of the source causa (or of the expediente for INTERNAL events).", "type": "string" }, "title": { "description": "Title.", "type": [ "string", "null" ] }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "id", "relatedCauseId", "source", "targetId", "title", "date", "path", "documentId", "detail", "total" ], "type": "object" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "rows", "total", "pageCount" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get expediente feed", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/actions/expedientes/workspace/resolve-bc-expediente": { "post": { "description": "Resolve bc expediente\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-expedientes-workspace-resolve-bc-expediente", "requestBody": { "content": { "application/json": { "example": { "args": [ { "boletinId": "", "orgId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "boletinId": { "type": "string" }, "orgId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "expedienteId": "string", "relatedCauseId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "expedienteId": { "type": "string" }, "relatedCauseId": { "description": "The expediente's link to this causa; empty when it only holds the causa through an exhorto/remisión family.", "type": "string" } }, "required": [ "expedienteId", "relatedCauseId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Resolve bc expediente", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/actions/expedientes/workspace/resolve-cause-expediente": { "post": { "description": "Resolve causa expediente\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-expedientes-workspace-resolve-cause-expediente", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "orgId": "", "type": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "orgId": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "expedienteId": "string", "relatedCauseId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "expedienteId": { "type": "string" }, "relatedCauseId": { "description": "The expediente's link to this causa; empty when it only holds the causa through an exhorto/remisión family.", "type": "string" } }, "required": [ "expedienteId", "relatedCauseId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Resolve causa expediente", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/actions/expedientes/workspace/search-expediente-causes": { "post": { "description": "Search expediente causes\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-expedientes-workspace-search-expediente-causes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "orgId": "", "search": "", "source": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "orgId": { "type": "string" }, "search": { "type": "string" }, "source": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causes": [ { "type": "OJV", "targetId": "string", "targetKind": "CAUSE", "source": "string", "snapshot": {}, "expedientes": [ { "id": "string", "name": "string", "type": "string", "targetId": "string" } ] } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causes": { "description": "Causas.", "items": { "properties": { "expedientes": { "description": "Visible expedientes that already hold this causa.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "targetId": { "description": "Id of the record the event is about.", "type": "string" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "name", "type", "targetId" ], "type": "object" }, "type": "array" }, "snapshot": { "description": "Display snapshot; keys depend on type: OJV rol, caratulado, competence, tribunalId, corteId, tribunal; TC/TCP rol, caratulado, status; TTA rol, ruc, caratulado, tribunal, competence, status, etapa, lastActuacionAt; BC rol, caratulado, tribunal, status, boletinSource." }, "source": { "description": "Where the record came from.", "type": "string" }, "targetId": { "description": "Id of the causa in its source.", "type": "string" }, "targetKind": { "description": "Kind of record the event is about.", "enum": [ "CAUSE" ], "type": "string" }, "type": { "description": "Record type.", "enum": [ "OJV", "TC", "TCP", "TTA", "BC" ], "type": "string" } }, "required": [ "type", "targetId", "targetKind", "source", "snapshot", "expedientes" ], "type": "object" }, "type": "array" } }, "required": [ "causes" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search expediente causes", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/actions/import/assistant/create-import-source": { "post": { "description": "Create import source\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-create-import-source", "requestBody": { "content": { "application/json": { "example": { "args": [ { "authMode": "", "clientId": "", "kind": "", "label": "", "login": "", "secret": "", "subdomain": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "authMode": { "type": "string" }, "clientId": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": "string" }, "login": { "type": "string" }, "secret": { "type": "string" }, "subdomain": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "existed": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "existed": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id", "existed" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create import source", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/import/assistant/delete-import-source": { "post": { "description": "Delete import source\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-delete-import-source", "requestBody": { "content": { "application/json": { "example": { "args": [ { "sourceId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "sourceId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete import source", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/import/assistant/dismiss-import-candidates": { "post": { "description": "Dismiss import candidates\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-dismiss-import-candidates", "requestBody": { "content": { "application/json": { "example": { "args": [ { "ids": [], "restore": false } ] }, "schema": { "properties": { "args": { "items": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" }, "restore": { "type": "boolean" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "updated": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "updated": { "description": "Whether anything changed.", "type": "integer" } }, "required": [ "updated" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Dismiss import candidates", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/import/assistant/import-candidates": { "post": { "description": "Import candidates\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-import-candidates", "requestBody": { "content": { "application/json": { "example": { "args": [ { "ids": [], "teamIds": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" }, "teamIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "result": { "\u003ckey\u003e": 0 }, "failures": [ { "id": "string", "rol": "string", "error": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "failures": { "description": "Candidates that could not be imported.", "items": { "properties": { "error": { "type": "string" }, "id": { "description": "Candidate id.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "id", "rol", "error" ], "type": "object" }, "type": "array" }, "result": { "additionalProperties": { "type": "integer" }, "description": "Counts keyed by outcome: imported, existing, skipped, failed; CaseTracking sources add the counts of the records materialized with them (clients, tasks, clientErrors, taskErrors, ...).", "type": "object" } }, "required": [ "result", "failures" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Import candidates", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/import/assistant/list-import-candidates": { "post": { "description": "List import candidates\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-list-import-candidates", "requestBody": { "content": { "application/json": { "example": { "args": [ { "competence": "", "estado": "", "filedFrom": "", "filedTo": "", "institucion": "", "limit": 0, "query": "", "sort": "", "sourceId": "", "status": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "competence": { "type": "string" }, "estado": { "type": "string" }, "filedFrom": { "type": "string" }, "filedTo": { "type": "string" }, "institucion": { "type": "string" }, "limit": { "type": "number" }, "query": { "type": "string" }, "sort": { "type": "string" }, "sourceId": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "id": "string", "competence": "string", "rol": "string", "court": "string", "caratulado": "string", "fechaIngreso": "string", "estado": "string", "institucion": "string", "status": "string", "skipReason": "string", "causaId": "string", "firstSeenAt": "2026-01-31T12:00:00Z", "notifiedAt": "2026-01-31T12:00:00Z" } ], "counts": { "NEW": 0, "IMPORTED": 0, "DISMISSED": 0, "SKIPPED": 0, "NOTIFIED": 0 }, "facets": { "competences": [ { "value": "string", "count": 0 } ], "estados": [ { "value": "string", "count": 0 } ] } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "counts": { "description": "Totals per category.", "properties": { "DISMISSED": { "type": "integer" }, "IMPORTED": { "type": "integer" }, "NEW": { "type": "integer" }, "NOTIFIED": { "type": "integer" }, "SKIPPED": { "type": "integer" } }, "required": [ "NEW", "IMPORTED", "DISMISSED", "SKIPPED", "NOTIFIED" ], "type": "object" }, "facets": { "properties": { "competences": { "description": "Up to 40 competences of the source's candidates, most common first.", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "value": { "description": "Competence, uppercase.", "type": "string" } }, "required": [ "value", "count" ], "type": "object" }, "type": "array" }, "estados": { "description": "Up to 40 estados of the source's candidates, most common first.", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "value", "count" ], "type": "object" }, "type": "array" } }, "required": [ "competences", "estados" ], "type": "object" }, "items": { "description": "The records returned.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "court": { "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaIngreso": { "description": "Date the causa was filed (ISO 8601).", "type": "string" }, "firstSeenAt": { "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "institucion": { "type": "string" }, "notifiedAt": { "format": "date-time", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "skipReason": { "type": "string" }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "id", "competence", "rol", "court", "caratulado", "fechaIngreso", "estado", "institucion", "status", "skipReason", "causaId", "firstSeenAt", "notifiedAt" ], "type": "object" }, "type": "array" } }, "required": [ "items", "counts", "facets" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List import candidates", "tags": [ "Integrations" ], "x-required-scope": "integrations:read" } }, "/api/actions/import/assistant/list-import-sources": { "post": { "description": "List import sources\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-list-import-sources", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "sources": [ { "id": "string", "kind": "string", "label": "string", "clientId": "string", "subdomain": "string", "authMode": "string", "login": "string", "dailyCheck": true, "dailyPaused": true, "lastRunAt": "2026-01-31T12:00:00Z", "lastRun": { "state": "string", "error": "string", "stats": "string", "startedAt": "2026-01-31T12:00:00Z" }, "organizations": [ { "id": "string", "value": "string", "name": "string", "follow": true } ] } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "sources": { "items": { "properties": { "authMode": { "type": "string" }, "clientId": { "description": "Client id.", "type": "string" }, "dailyCheck": { "type": "boolean" }, "dailyPaused": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "lastRun": { "properties": { "error": { "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "stats": { "type": "string" } }, "required": [ "state", "error", "stats", "startedAt" ], "type": "object" }, "lastRunAt": { "format": "date-time", "type": [ "string", "null" ] }, "login": { "type": "string" }, "organizations": { "description": "Organizations.", "items": { "properties": { "follow": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "id", "value", "name", "follow" ], "type": "object" }, "type": "array" }, "subdomain": { "type": "string" } }, "required": [ "id", "kind", "label", "clientId", "subdomain", "authMode", "login", "dailyCheck", "dailyPaused", "lastRunAt" ], "type": "object" }, "type": "array" } }, "required": [ "sources" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List import sources", "tags": [ "Integrations" ], "x-required-scope": "integrations:read" } }, "/api/actions/import/assistant/refresh-import-organizations": { "post": { "description": "Refresh import organizations\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-refresh-import-organizations", "requestBody": { "content": { "application/json": { "example": { "args": [ { "sourceId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "sourceId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "count": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "count": { "description": "Number of records.", "type": "integer" } }, "required": [ "count" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Refresh import organizations", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/import/assistant/run-import": { "post": { "description": "Run import\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-run-import", "requestBody": { "content": { "application/json": { "example": { "args": [ { "organizations": [], "sourceId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "organizations": { "items": { "type": "string" }, "type": "array" }, "sourceId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "runId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "runId": { "type": "string" } }, "required": [ "runId" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Run import", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/import/assistant/set-import-daily-paused": { "post": { "description": "Set import daily paused\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-set-import-daily-paused", "requestBody": { "content": { "application/json": { "example": { "args": [ { "paused": false, "sourceId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "paused": { "type": "boolean" }, "sourceId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true, "paused": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" }, "paused": { "type": "boolean" } }, "required": [ "ok", "paused" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set import daily paused", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/import/assistant/set-import-organization-follow": { "post": { "description": "Set import organization follow\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-set-import-organization-follow", "requestBody": { "content": { "application/json": { "example": { "args": [ { "follow": false, "organizationId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "follow": { "type": "boolean" }, "organizationId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set import organization follow", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/import/assistant/test-import-connection": { "post": { "description": "Test import connection\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-test-import-connection", "requestBody": { "content": { "application/json": { "example": { "args": [ { "authMode": "", "clientId": "", "kind": "", "label": "", "login": "", "secret": "", "subdomain": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "authMode": { "type": "string" }, "clientId": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": "string" }, "login": { "type": "string" }, "secret": { "type": "string" }, "subdomain": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true, "error": "string", "cases": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "cases": { "description": "Cases.", "type": "integer" }, "error": { "type": "string" }, "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Test import connection", "tags": [ "Integrations" ], "x-required-scope": "integrations:read" } }, "/api/actions/import/assistant/upload-import-spreadsheet": { "post": { "description": "Upload import spreadsheet\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-import-assistant-upload-import-spreadsheet", "requestBody": { "content": { "application/json": { "example": { "args": [ { "contentBase64": "", "filename": "", "label": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "contentBase64": { "type": "string" }, "filename": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "rows": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "rows": { "description": "The records on this page.", "type": "integer" } }, "required": [ "id", "rows" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload import spreadsheet", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/internal-cases/helpers/search-internal-cases-for-task": { "post": { "description": "Search internal cases for task\n\nAuthentication: developer API key. Required scope: `internal-cases:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-helpers-search-internal-cases-for-task", "requestBody": { "content": { "application/json": { "example": { "args": [ "", "", "" ] }, "schema": { "properties": { "args": { "prefixItems": [ { "type": "string" }, { "type": "string" }, { "type": "string" } ], "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "id": "string", "rol": "string", "caratulado": "string", "states": [ { "stateSlug": "string", "stateName": "string", "stateColor": "string", "changedAt": "2026-01-31T12:00:00Z", "changedById": "string", "counter": 0 } ] } ], "schema": { "description": "Internal cases matching the search.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "states": { "description": "State history of the internal case, oldest first; the last entry is the current state.", "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "changedById": { "type": "string" }, "counter": { "description": "Days spent in the state, set when it is left; 0 for the current one.", "type": "integer" }, "stateColor": { "type": [ "string", "null" ] }, "stateName": { "type": "string" }, "stateSlug": { "type": "string" } }, "required": [ "stateSlug", "stateName", "changedAt", "changedById", "counter" ], "type": "object" }, "type": "array" } }, "required": [ "id", "rol", "caratulado", "states" ], "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search internal cases for task", "tags": [ "Expedientes and activity" ], "x-required-scope": "internal-cases:read" } }, "/api/actions/internal-cases/mutations/add-document-reference": { "post": { "description": "Add document reference\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-add-document-reference", "requestBody": { "content": { "application/json": { "example": { "args": [ { "description": "", "folderId": "", "internalCauseId": "", "mimeType": "", "name": "", "size": 0, "url": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "description": { "type": "string" }, "folderId": { "type": "string" }, "internalCauseId": { "type": "string" }, "mimeType": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "number" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true, "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add document reference", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/archive-internal-case": { "post": { "description": "Archive internal case\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-archive-internal-case", "requestBody": { "content": { "application/json": { "example": { "args": [ "", false ] }, "schema": { "properties": { "args": { "prefixItems": [ { "type": "string" }, { "type": "boolean" } ], "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Archive internal case", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/assign-internal-case-team": { "post": { "description": "Assign internal case team\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-assign-internal-case-team", "requestBody": { "content": { "application/json": { "example": { "args": [ { "internalCaseIds": [], "teamId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "internalCaseIds": { "items": { "type": "string" }, "type": "array" }, "teamId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "updated": 0, "requested": 0, "skipped": [ "string" ], "causasTagged": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causasTagged": { "type": "integer" }, "requested": { "description": "Number of items requested.", "type": "integer" }, "skipped": { "description": "Number of items skipped.", "items": { "type": "string" }, "type": "array" }, "updated": { "description": "Whether anything changed.", "type": "integer" } }, "required": [ "updated", "requested", "skipped", "causasTagged" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Assign internal case team", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/change-internal-case-state": { "post": { "description": "Change internal case state\n\nAuthentication: developer API key. Required scope: `internal-cases:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-change-internal-case-state", "requestBody": { "content": { "application/json": { "example": { "args": [ { "auto": false, "internalCauseId": "", "newStateSlug": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "auto": { "type": "boolean" }, "internalCauseId": { "type": "string" }, "newStateSlug": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Change internal case state", "tags": [ "Expedientes and activity" ], "x-required-scope": "internal-cases:read" } }, "/api/actions/internal-cases/mutations/create-cost-entry": { "post": { "description": "Create cost entry\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-create-cost-entry", "requestBody": { "content": { "application/json": { "example": { "args": [ { "amount": 0, "billable": false, "category": "", "currency": "", "description": "", "incurredAt": "", "internalCauseId": "", "vendor": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "amount": { "type": "number" }, "billable": { "type": "boolean" }, "category": { "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "incurredAt": { "type": "string" }, "internalCauseId": { "type": "string" }, "vendor": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create cost entry", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/create-folder": { "post": { "description": "Create folder\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-create-folder", "requestBody": { "content": { "application/json": { "example": { "args": [ { "description": "", "internalCauseId": "", "name": "", "parentFolderId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "description": { "type": "string" }, "internalCauseId": { "type": "string" }, "name": { "type": "string" }, "parentFolderId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true, "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create folder", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/create-internal-case": { "post": { "description": "Create an internal case (expediente). args[0]: rol, caratulado, initialStateSlug (from get-internal-case-settings), orgId and teamIds are required.\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-create-internal-case", "requestBody": { "content": { "application/json": { "example": { "args": [ { "assignedUserIds": [], "caratulado": "PÉREZ / BANCO", "initialStateSlug": "\u003cSTATE_SLUG\u003e", "orgId": "\u003cORG_ID\u003e", "rol": "C-1234-2024", "tagSlugs": [], "teamIds": [ "\u003cTEAM_ID\u003e" ] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "archived": { "type": "boolean" }, "assignedUserIds": { "items": { "type": "string" }, "type": "array" }, "caratulado": { "type": "string" }, "description": { "type": "string" }, "fechaDeIng": { "type": "string" }, "initialStateSlug": { "type": "string" }, "jpl": { "type": "string" }, "metadata": { "items": { "type": "object" }, "type": "array" }, "orgId": { "type": "string" }, "region": { "type": "string" }, "relatedCauses": { "items": { "type": "object" }, "type": "array" }, "rol": { "type": "string" }, "tagSlugs": { "items": { "type": "string" }, "type": "array" }, "teamIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true, "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success", "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create internal case", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/create-time-entry": { "post": { "description": "Create time entry\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-create-time-entry", "requestBody": { "content": { "application/json": { "example": { "args": [ { "billable": false, "description": "", "entryDate": "", "hourlyRate": 0, "internalCauseId": "", "minutes": 0, "userId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "billable": { "type": "boolean" }, "description": { "type": "string" }, "entryDate": { "type": "string" }, "hourlyRate": { "type": "number" }, "internalCauseId": { "type": "string" }, "minutes": { "type": "number" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create time entry", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/delete-cost-entry": { "post": { "description": "Delete cost entry\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-delete-cost-entry", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003centryID\u003e" ] }, "schema": { "properties": { "args": { "items": { "description": "entryID", "type": "string" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete cost entry", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/delete-internal-case": { "post": { "description": "Delete internal case\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-delete-internal-case", "requestBody": { "content": { "application/json": { "example": { "args": [ "" ] }, "schema": { "properties": { "args": { "items": { "type": "string" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete internal case", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/delete-time-entry": { "post": { "description": "Delete time entry\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-delete-time-entry", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003centryID\u003e" ] }, "schema": { "properties": { "args": { "items": { "description": "entryID", "type": "string" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete time entry", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/replace-related-causes": { "post": { "description": "Replace related causes\n\nAuthentication: developer API key. Required scope: `internal-cases:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-replace-related-causes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "internalCauseId": "", "relatedCauses": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "internalCauseId": { "type": "string" }, "relatedCauses": { "items": { "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Replace related causes", "tags": [ "Expedientes and activity" ], "x-required-scope": "internal-cases:read" } }, "/api/actions/internal-cases/mutations/save-internal-case-settings": { "post": { "description": "Save internal case settings\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-save-internal-case-settings", "requestBody": { "content": { "application/json": { "example": { "args": [ { "fields": [], "states": [], "tags": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "fields": { "items": { "type": "object" }, "type": "array" }, "states": { "items": { "type": "object" }, "type": "array" }, "tags": { "items": { "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save internal case settings", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/mutations/update-internal-case": { "post": { "description": "Update internal case\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-mutations-update-internal-case", "requestBody": { "content": { "application/json": { "example": { "args": [ { "archived": false, "assignedUserIds": [], "caratulado": "", "description": "", "fechaDeIng": "", "id": "", "jpl": "", "metadata": [], "region": "", "rol": "", "tagSlugs": [], "teamIds": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "archived": { "type": "boolean" }, "assignedUserIds": { "items": { "type": "string" }, "type": "array" }, "caratulado": { "type": "string" }, "description": { "type": "string" }, "fechaDeIng": { "type": "string" }, "id": { "type": "string" }, "jpl": { "type": "string" }, "metadata": { "items": { "type": "object" }, "type": "array" }, "region": { "type": "string" }, "rol": { "type": "string" }, "tagSlugs": { "items": { "type": "string" }, "type": "array" }, "teamIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update internal case", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "internal-cases:write" } }, "/api/actions/internal-cases/queries/get-internal-case-detail": { "post": { "description": "One internal case. args[0] is the id as a bare string, not an object.\n\nAuthentication: developer API key. Required scope: `internal-cases:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-queries-get-internal-case-detail", "requestBody": { "content": { "application/json": { "example": { "args": [ "\u003cINTERNAL_CASE_ID\u003e" ] }, "schema": { "properties": { "args": { "items": { "description": "id", "type": "string" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "internalCase": { "id": "string", "orgId": "string", "orgName": "string", "rol": "string", "caratulado": "string", "description": "string", "fechaDeIng": "2026-01-31T12:00:00Z", "region": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "teamIds": [ "string" ], "createdById": "string", "assignedUserIds": [ "string" ], "participants": {}, "jpl": "string", "currentStateSlug": "string", "states": [ { "stateSlug": "string", "stateName": "string", "stateColor": "string", "changedAt": "2026-01-31T12:00:00Z", "changedById": "string", "counter": 0 } ], "tagSlugs": [ "string" ], "metadata": {}, "archived": true, "aiAccessEnabled": true, "aiAccessOrgEnabled": true, "relatedCauses": [ { "id": "string", "displayName": "string", "order": 0, "type": "string", "source": "string", "identityKey": "string", "targetKind": "string", "targetId": "string", "snapshot": true, "relation": { "kind": "string", "parentRol": "string", "parentCausaId": "string" }, "autoTracked": true } ], "folders": [ { "id": "string", "name": "string", "description": "string", "parentFolderId": "string", "relatedCauseId": "string", "createdAt": "2026-01-31T12:00:00Z" } ], "documents": [ { "id": "string", "name": "string", "url": "string", "size": 0, "mimeType": "string", "description": "string", "folderId": "string", "relatedCauseId": true, "uploadState": true, "uploadedAt": "2026-01-31T12:00:00Z" } ], "timeEntries": [ { "id": "string", "entryDate": "2026-01-31T12:00:00Z", "minutes": 0, "description": "string", "billable": true, "hourlyRate": 0, "userId": "string", "createdAt": "2026-01-31T12:00:00Z" } ], "costEntries": [ { "id": "string", "incurredAt": "2026-01-31T12:00:00Z", "category": "string", "amount": 0, "currency": "string", "vendor": "string", "description": "string", "billable": true, "createdAt": "2026-01-31T12:00:00Z" } ], "rollups": { "totalTrackedMinutes": 0, "totalTrackedCost": 0, "documentCount": 0, "relatedCauseCount": 0 } }, "settings": { "states": [ { "slug": "string", "name": "string", "color": "string" } ], "tags": [ { "slug": "string", "name": "string", "color": "string" } ], "fields": [ { "key": "string", "label": "string", "type": "string", "required": true, "placeholder": "string", "options": [ "string" ] } ], "users": [ { "id": "string", "n": "string", "e": "string", "r": "string", "inv": "string", "pc": true, "it": [ 0 ] } ] } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "internalCase": { "description": "The linked expediente.", "properties": { "aiAccessEnabled": { "description": "Whether AI features may read this causa.", "type": "boolean" }, "aiAccessOrgEnabled": { "description": "Whether the organization allows AI features.", "type": "boolean" }, "archived": { "description": "Whether the record is archived.", "type": "boolean" }, "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "costEntries": { "items": { "properties": { "amount": { "description": "Amount.", "type": "number" }, "billable": { "description": "Whether the time is billable.", "type": "boolean" }, "category": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "description": { "description": "Free-text description.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "incurredAt": { "format": "date-time", "type": "string" }, "vendor": { "type": [ "string", "null" ] } }, "required": [ "id", "incurredAt", "category", "amount", "currency", "vendor", "description", "billable", "createdAt" ], "type": "object" }, "type": "array" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdById": { "type": "string" }, "currentStateSlug": { "description": "Slug of the current workflow state.", "type": [ "string", "null" ] }, "description": { "description": "Free-text description.", "type": [ "string", "null" ] }, "documents": { "description": "Documents.", "items": { "properties": { "description": { "description": "Free-text description.", "type": [ "string", "null" ] }, "folderId": { "description": "Optional folder", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": [ "string", "null" ] }, "name": { "description": "Display name.", "type": "string" }, "relatedCauseId": { "type": "boolean" }, "size": { "description": "File size in bytes", "type": [ "integer", "null" ] }, "uploadState": { "type": "boolean" }, "uploadedAt": { "format": "date-time", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "id", "name", "url", "size", "mimeType", "description", "folderId", "relatedCauseId", "uploadState", "uploadedAt" ], "type": "object" }, "type": "array" }, "fechaDeIng": { "description": "Filing date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "folders": { "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "description": { "description": "Free-text description.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "parentFolderId": { "description": "For nested folders", "type": [ "string", "null" ] }, "relatedCauseId": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "description", "parentFolderId", "relatedCauseId", "createdAt" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "jpl": { "type": [ "string", "null" ] }, "metadata": { "description": "Custom field values keyed by custom field key (free-form jsonb; may also hold internal markers such as consolidatedInto)." }, "orgId": { "description": "Organization id.", "type": "string" }, "orgName": { "description": "Organization name.", "type": "string" }, "participants": { "description": "Legacy participant objects stored on the internal case (free-form jsonb array)." }, "region": { "description": "Chilean region.", "type": [ "string", "null" ] }, "relatedCauses": { "items": { "properties": { "autoTracked": { "description": "Whether Nexulex started tracking it automatically (e.g. an exhorto of a tracked causa).", "type": "boolean" }, "displayName": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "identityKey": { "type": "string" }, "order": { "description": "Sort position.", "type": "integer" }, "relation": { "description": "How this causa relates to its parent causa; null when it has none.", "properties": { "kind": { "description": "Record subtype.", "type": "string" }, "parentCausaId": { "description": "Id of the parent causa.", "type": "string" }, "parentRol": { "description": "En Laboral, Penal, Cobranza es RIT", "type": "string" } }, "required": [ "kind", "parentRol", "parentCausaId" ], "type": [ "object", "null" ] }, "snapshot": { "type": "boolean" }, "source": { "description": "Where the record came from.", "type": "string" }, "targetId": { "description": "Id of the record the event is about.", "type": [ "string", "null" ] }, "targetKind": { "description": "Kind of record the event is about.", "type": [ "string", "null" ] }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "displayName", "order", "type", "source", "identityKey", "targetKind", "targetId", "snapshot", "relation", "autoTracked" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "rollups": { "properties": { "documentCount": { "description": "Number of documents.", "type": "integer" }, "relatedCauseCount": { "type": "integer" }, "totalTrackedCost": { "type": "number" }, "totalTrackedMinutes": { "description": "Total tracked minutes.", "type": "integer" } }, "required": [ "totalTrackedMinutes", "totalTrackedCost", "documentCount", "relatedCauseCount" ], "type": "object" }, "states": { "description": "State history of the internal case, oldest first; the last entry is the current state.", "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "changedById": { "type": "string" }, "counter": { "description": "Days spent in the state, set when it is left; 0 for the current one.", "type": "integer" }, "stateColor": { "type": [ "string", "null" ] }, "stateName": { "type": "string" }, "stateSlug": { "type": "string" } }, "required": [ "stateSlug", "stateName", "changedAt", "changedById", "counter" ], "type": "object" }, "type": "array" }, "tagSlugs": { "items": { "type": "string" }, "type": "array" }, "teamIds": { "description": "Ids of the teams it is assigned to.", "items": { "type": "string" }, "type": "array" }, "timeEntries": { "items": { "properties": { "billable": { "description": "Whether the time is billable.", "type": "boolean" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "description": { "description": "Free-text description.", "type": [ "string", "null" ] }, "entryDate": { "format": "date-time", "type": "string" }, "hourlyRate": { "type": [ "number", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "minutes": { "description": "Minutes.", "type": "integer" }, "userId": { "description": "User id.", "type": [ "string", "null" ] } }, "required": [ "id", "entryDate", "minutes", "description", "billable", "hourlyRate", "userId", "createdAt" ], "type": "object" }, "type": "array" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "orgId", "orgName", "rol", "caratulado", "description", "fechaDeIng", "region", "createdAt", "updatedAt", "teamIds", "createdById", "assignedUserIds", "participants", "jpl", "currentStateSlug", "states", "tagSlugs", "metadata", "archived", "aiAccessEnabled", "aiAccessOrgEnabled", "relatedCauses", "folders", "documents", "timeEntries", "costEntries", "rollups" ], "type": "object" }, "settings": { "properties": { "fields": { "description": "Internal case custom fields (projection of the INTERNAL_CASE custom attributes).", "items": { "properties": { "key": { "description": "Custom attribute key (the key in metadata).", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "options": { "description": "Choices of a select attribute.", "items": { "type": "string" }, "type": "array" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "type": { "description": "Attribute type, lowercase (text, number, date, select, ...).", "type": "string" } }, "required": [ "key", "label", "type", "required" ], "type": "object" }, "type": "array" }, "states": { "description": "The organization's internal case states.", "items": { "properties": { "color": { "description": "CSS color; absent when none was chosen.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "slug": { "description": "URL-safe identifier.", "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "type": "array" }, "tags": { "description": "The organization's internal case tags.", "items": { "properties": { "color": { "description": "CSS color; absent when none was chosen.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "slug": { "description": "URL-safe identifier.", "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "type": "array" }, "users": { "description": "Organization members and invites as stored on the organization.", "items": { "properties": { "e": { "description": "Member or invitee email.", "type": "string" }, "id": { "description": "User id; empty for a pending invite.", "type": "string" }, "inv": { "description": "Invitation state: A accepted, P pending, D declined.", "type": "string" }, "it": { "description": "Unix seconds of recent invite sends (pending invites).", "items": { "type": "integer" }, "type": "array" }, "n": { "description": "Member name.", "type": "string" }, "pc": { "description": "Whether the member may connect judicial portals; absent means allowed.", "type": "boolean" }, "r": { "description": "Organization role.", "type": "string" } }, "required": [ "id", "r" ], "type": "object" }, "type": "array" } }, "required": [ "states", "tags", "fields", "users" ], "type": "object" } }, "required": [ "internalCase", "settings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get internal case detail", "tags": [ "Expedientes and activity" ], "x-required-scope": "internal-cases:read" } }, "/api/actions/internal-cases/queries/get-internal-case-settings": { "post": { "description": "Get internal case settings\n\nAuthentication: developer API key. Required scope: `internal-cases:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-queries-get-internal-case-settings", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "organization": { "id": "string", "name": "string", "canEdit": true, "states": [ { "slug": "string", "name": "string", "color": "string" } ], "tags": [ { "slug": "string", "name": "string", "color": "string" } ], "fields": [ { "key": "string", "label": "string", "type": "string", "required": true, "placeholder": "string", "options": [ "string" ] } ], "users": [ { "id": "string", "n": "string", "e": "string", "r": "string", "inv": "string", "pc": true, "it": [ 0 ] } ], "teams": [ { "id": "string", "name": "string" } ] } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "organization": { "properties": { "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "fields": { "description": "Internal case custom fields (projection of the INTERNAL_CASE custom attributes).", "items": { "properties": { "key": { "description": "Custom attribute key (the key in metadata).", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "options": { "description": "Choices of a select attribute.", "items": { "type": "string" }, "type": "array" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "type": { "description": "Attribute type, lowercase (text, number, date, select, ...).", "type": "string" } }, "required": [ "key", "label", "type", "required" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "states": { "description": "The organization's internal case states.", "items": { "properties": { "color": { "description": "CSS color; absent when none was chosen.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "slug": { "description": "URL-safe identifier.", "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "type": "array" }, "tags": { "description": "The organization's internal case tags.", "items": { "properties": { "color": { "description": "CSS color; absent when none was chosen.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "slug": { "description": "URL-safe identifier.", "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "type": "array" }, "teams": { "description": "Teams.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "type": "array" }, "users": { "description": "Organization members and invites as stored on the organization.", "items": { "properties": { "e": { "description": "Member or invitee email.", "type": "string" }, "id": { "description": "User id; empty for a pending invite.", "type": "string" }, "inv": { "description": "Invitation state: A accepted, P pending, D declined.", "type": "string" }, "it": { "description": "Unix seconds of recent invite sends (pending invites).", "items": { "type": "integer" }, "type": "array" }, "n": { "description": "Member name.", "type": "string" }, "pc": { "description": "Whether the member may connect judicial portals; absent means allowed.", "type": "boolean" }, "r": { "description": "Organization role.", "type": "string" } }, "required": [ "id", "r" ], "type": "object" }, "type": "array" } }, "required": [ "id", "name", "canEdit", "states", "tags", "fields", "users", "teams" ], "type": "object" } }, "required": [ "organization" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get internal case settings", "tags": [ "Expedientes and activity" ], "x-required-scope": "internal-cases:read" } }, "/api/actions/internal-cases/queries/get-internal-cases": { "post": { "description": "List the organization's internal cases.\n\nAuthentication: developer API key. Required scope: `internal-cases:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-queries-get-internal-cases", "requestBody": { "content": { "application/json": { "example": { "args": [ { "page": 1, "per_page": 25, "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "activityFrom": { "type": "string" }, "activityTo": { "type": "string" }, "archived": { "type": "string" }, "attributeFrom": { "type": "string" }, "attributeId": { "type": "string" }, "attributeOp": { "type": "string" }, "attributeTo": { "type": "string" }, "attributeValue": { "type": "string" }, "clientFilter": { "type": "string" }, "competence": { "type": "string" }, "coverage": { "type": "string" }, "createdFrom": { "type": "string" }, "createdTo": { "type": "string" }, "hideAutoRelated": { "type": "boolean" }, "page": { "type": "number" }, "perPage": { "type": "number" }, "per_page": { "type": "number" }, "responsible": { "type": "string" }, "search": { "type": "string" }, "sort": { "type": "string" }, "source": { "type": "string" }, "stateSlug": { "type": "string" }, "tagSlug": { "type": "string" }, "team": { "type": "string" }, "view": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "internalCases": [ { "id": "string", "orgId": "string", "organizationName": "string", "rol": "string", "caratulado": "string", "description": "string", "fechaDeIng": "2026-01-31T12:00:00Z", "region": "string", "currentStateSlug": "string", "tagSlugs": [ "string" ], "metadata": {}, "states": [ { "slug": "string", "name": "string", "color": "string" } ], "organizationTags": [ { "slug": "string", "name": "string", "color": "string" } ], "archived": true, "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "assignedUserIds": [ "string" ], "teamIds": [ "string" ], "relatedCauseCount": 0, "documentCount": 0, "totalTrackedMinutes": 0, "totalTrackedCost": 0 } ], "pageCount": 0, "total": 0, "representedCauses": 0, "coverage": { "status": "string", "total": 0, "represented": 0, "pending": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "coverage": { "properties": { "pending": { "description": "Number pending.", "type": "integer" }, "represented": { "type": "integer" }, "status": { "description": "Current status.", "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "status" ], "type": "object" }, "internalCases": { "items": { "properties": { "archived": { "description": "Whether the record is archived.", "type": "boolean" }, "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "currentStateSlug": { "description": "Slug of the current workflow state.", "type": [ "string", "null" ] }, "description": { "description": "Free-text description.", "type": [ "string", "null" ] }, "documentCount": { "description": "Number of documents.", "type": [ "integer", "null" ] }, "fechaDeIng": { "description": "Filing date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "metadata": { "description": "Custom field values keyed by custom field key (free-form jsonb; may also hold internal markers such as consolidatedInto)." }, "orgId": { "description": "Organization id.", "type": "string" }, "organizationName": { "description": "Organization name.", "type": "string" }, "organizationTags": { "description": "The organization's internal case tags.", "items": { "properties": { "color": { "description": "CSS color; absent when none was chosen.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "slug": { "description": "URL-safe identifier.", "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "type": "array" }, "region": { "description": "Chilean region.", "type": [ "string", "null" ] }, "relatedCauseCount": { "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "states": { "description": "The organization's internal case states.", "items": { "properties": { "color": { "description": "CSS color; absent when none was chosen.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "slug": { "description": "URL-safe identifier.", "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "type": "array" }, "tagSlugs": { "items": { "type": "string" }, "type": "array" }, "teamIds": { "description": "Ids of the teams it is assigned to.", "items": { "type": "string" }, "type": "array" }, "totalTrackedCost": { "type": "integer" }, "totalTrackedMinutes": { "description": "Total tracked minutes.", "type": "integer" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "orgId", "organizationName", "rol", "caratulado", "description", "fechaDeIng", "region", "currentStateSlug", "tagSlugs", "metadata", "states", "organizationTags", "archived", "createdAt", "updatedAt", "assignedUserIds", "teamIds", "relatedCauseCount", "documentCount", "totalTrackedMinutes", "totalTrackedCost" ], "type": "object" }, "type": "array" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "representedCauses": { "type": "integer" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get internal cases", "tags": [ "Expedientes and activity" ], "x-required-scope": "internal-cases:read" } }, "/api/actions/internal-cases/queries/get-total-active-internal-cases-count": { "post": { "description": "Get total active internal cases count\n\nAuthentication: developer API key. Required scope: `internal-cases:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-queries-get-total-active-internal-cases-count", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "total": 0 }, "schema": { "properties": { "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "total" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get total active internal cases count", "tags": [ "Expedientes and activity" ], "x-required-scope": "internal-cases:read" } }, "/api/actions/internal-cases/queries/search-ojv-causes": { "post": { "description": "Search ojv causes\n\nAuthentication: developer API key. Required scope: `internal-cases:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-internal-cases-queries-search-ojv-causes", "requestBody": { "content": { "application/json": { "example": { "args": [ "", "", [] ] }, "schema": { "properties": { "args": { "prefixItems": [ { "type": "string" }, { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "id": "string", "rol": "string", "competence": "string", "caratulado": "string", "corteId": 0, "tribunalId": 0 } ], "schema": { "description": "Causas matching the search.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "competence": { "description": "Competence enum name; empty when unknown.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "rol", "competence", "caratulado", "corteId", "tribunalId" ], "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"internal-cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"internal-cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "internal-cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search ojv causes", "tags": [ "PJUD causas" ], "x-required-scope": "internal-cases:read" } }, "/api/actions/liquidations/mutations/add-liquidacion-related-cause": { "post": { "description": "Add liquidacion related causa\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-mutations-add-liquidacion-related-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caratulado": "", "causaBcId": "", "causaId": "", "note": "", "relationType": "", "rol": "", "tribunal": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caratulado": { "type": "string" }, "causaBcId": { "type": "string" }, "causaId": { "type": "string" }, "note": { "type": "string" }, "relationType": { "type": "string" }, "rol": { "type": "string" }, "tribunal": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "relationType": "ACCION_REVOCATORIA", "note": "string", "causaId": "string", "rol": "string", "caratulado": "string", "tribunal": "string", "competence": "string", "corteId": 0, "tribunalId": 0, "createdAt": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "causaId": { "description": "Tracked PJUD causa, null for a manual entry.", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": [ "string", "null" ] }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "note": { "description": "Free-text note.", "type": [ "string", "null" ] }, "relationType": { "description": "How the causas are related.", "enum": [ "ACCION_REVOCATORIA", "NULIDAD", "OTRA" ], "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "relationType", "note", "causaId", "rol", "caratulado", "tribunal", "competence", "corteId", "tribunalId", "createdAt" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add liquidacion related causa", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/mutations/delete-liquidacion-bitacora": { "post": { "description": "Delete liquidacion bitacora\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-mutations-delete-liquidacion-bitacora", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaBcId": "", "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaBcId": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete liquidacion bitacora", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/mutations/remove-liquidacion-related-cause": { "post": { "description": "Remove liquidacion related causa\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-mutations-remove-liquidacion-related-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaBcId": "", "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaBcId": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove liquidacion related causa", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/mutations/review-liquidacion-finding": { "post": { "description": "Review liquidacion finding\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-mutations-review-liquidacion-finding", "requestBody": { "content": { "application/json": { "example": { "args": [ { "assignedUserIds": [], "createTask": false, "dueDate": "", "findingId": "", "reviewNote": "", "reviewedState": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "assignedUserIds": { "items": { "type": "string" }, "type": "array" }, "createTask": { "type": "boolean" }, "dueDate": { "type": "string" }, "findingId": { "type": "string" }, "reviewNote": { "type": "string" }, "reviewedState": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causaBcId": "string", "taskId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causaBcId": { "type": "string" }, "taskId": { "description": "Task id.", "type": "string" } }, "required": [ "causaBcId", "taskId" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Review liquidacion finding", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/mutations/set-liquidacion-assignees": { "post": { "description": "Set liquidacion assignees\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-mutations-set-liquidacion-assignees", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaBcId": "", "userIds": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaBcId": { "type": "string" }, "userIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "assignedUserIds": [ "string" ], "assignees": [ { "userId": "string", "name": "string", "email": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "assignedUserIds": { "description": "Assigned ids visible to this org.", "items": { "type": "string" }, "type": "array" }, "assignees": { "items": { "properties": { "email": { "description": "Email address.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "email" ], "type": "object" }, "type": "array" } }, "required": [ "assignedUserIds", "assignees" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set liquidacion assignees", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/mutations/upsert-liquidacion-bitacora": { "post": { "description": "Upsert liquidacion bitacora\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-mutations-upsert-liquidacion-bitacora", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaBcId": "", "content": "", "id": "", "title": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaBcId": { "type": "string" }, "content": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "bitacora": { "id": "string", "title": "string", "content": "string", "orgId": "string", "createdAt": "string", "updatedAt": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "bitacora": { "properties": { "content": { "description": "Content.", "type": "string" }, "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "updatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" } }, "required": [ "id", "title", "content", "orgId", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "bitacora" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upsert liquidacion bitacora", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/mutations/upsert-liquidacion-movement-note": { "post": { "description": "Upsert liquidacion movement note\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-mutations-upsert-liquidacion-movement-note", "requestBody": { "content": { "application/json": { "example": { "args": [ { "itemDesc": "", "targetId": "", "targetType": "", "text": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "itemDesc": { "type": "string" }, "targetId": { "type": "string" }, "targetType": { "type": "string" }, "text": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "note": { "id": "string", "text": "string", "itemDesc": "string", "orgId": "string", "modifiedById": "string", "createdAt": "string", "updatedAt": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "note": { "description": "null after empty text deleted the note.", "properties": { "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "itemDesc": { "type": "string" }, "modifiedById": { "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" } }, "required": [ "id", "text", "itemDesc", "orgId", "modifiedById", "createdAt", "updatedAt" ], "type": [ "object", "null" ] } }, "required": [ "note" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upsert liquidacion movement note", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/mutations/upsert-liquidacion-note": { "post": { "description": "Upsert liquidacion note\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-mutations-upsert-liquidacion-note", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaBcId": "", "itemDesc": "", "text": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaBcId": { "type": "string" }, "itemDesc": { "type": "string" }, "text": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "note": { "id": "string", "text": "string", "itemDesc": "string", "orgId": "string", "causaBcId": "string", "modifiedById": "string", "createdAt": "string", "updatedAt": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "note": { "description": "null after empty text deleted the note.", "properties": { "causaBcId": { "type": "string" }, "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "itemDesc": { "type": "string" }, "modifiedById": { "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" } }, "required": [ "id", "text", "itemDesc", "orgId", "causaBcId", "modifiedById", "createdAt", "updatedAt" ], "type": [ "object", "null" ] } }, "required": [ "note" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upsert liquidacion note", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/portal/analyze-liquidacion-workspace": { "post": { "description": "Analyze liquidacion workspace\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-analyze-liquidacion-workspace", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "state": "QUEUED", "message": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "message": { "type": "string" }, "state": { "description": "Current state.", "enum": [ "QUEUED" ], "type": "string" } }, "required": [ "state", "message" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Analyze liquidacion workspace", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/portal/delete-liquidacion-operation": { "post": { "description": "Delete liquidacion operation\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-delete-liquidacion-operation", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "state": "string", "verified": true, "message": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "message": { "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "state", "verified", "message" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete liquidacion operation", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/portal/generate-liquidacion-draft": { "post": { "description": "Generate liquidacion draft\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-generate-liquidacion-draft", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "title": "string", "kind": "string", "state": "DRAFT", "body": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "contexto": "string", "sugerencia": "string", "opciones": [ { "tipo": "liquidador", "nombre": "string", "rut": "string", "patrocinaEnCausa": true, "ultimoUso": "string" } ], "permiteNuevo": true } ], "files": [ { "id": "string", "name": "string", "path": "string", "mimeType": "string" } ], "error": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "body": { "description": "Draft text.", "type": "string" }, "error": { "description": "Export problem, empty when none.", "type": "string" }, "files": { "items": { "properties": { "id": { "description": "Artifact id plus \":docx\" or \":pdf\".", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Storage object path.", "type": "string" } }, "required": [ "id", "name", "path", "mimeType" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Draft kind, e.g. judicial or administrative.", "type": "string" }, "missingFields": { "description": "Data the draft still lacks.", "items": { "properties": { "clave": { "description": "Placeholder key.", "type": "string" }, "contexto": { "type": "string" }, "opciones": { "description": "Choices for a gap answered by picking one (the firma gap).", "items": { "properties": { "nombre": { "description": "Display name.", "type": "string" }, "patrocinaEnCausa": { "description": "The abogado already sponsors in this causa.", "type": "boolean" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "tipo": { "description": "Record type.", "enum": [ "liquidador", "abogado" ], "type": "string" }, "ultimoUso": { "description": "Last time the abogado appeared in the liquidador's escritos (YYYY-MM-DD).", "type": "string" } }, "required": [ "tipo" ], "type": "object" }, "type": "array" }, "permiteNuevo": { "description": "A new value may be entered besides the opciones.", "type": "boolean" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "sugerencia": { "description": "Suggested value.", "type": "string" } }, "required": [ "clave", "pregunta" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state.", "enum": [ "DRAFT", "EXPORT_PENDING" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "kind", "state", "body", "missingFields", "files", "error" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Generate liquidacion draft", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/portal/get-liquidacion-portal-form": { "post": { "description": "Get liquidacion portal form\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-get-liquidacion-portal-form", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "preparedId": "string", "operationKey": "string", "title": "string", "fields": [ { "name": "string", "label": "string", "type": "string", "value": "string", "required": true, "disabled": true, "multiple": true, "accept": "string", "options": [ { "value": "string", "label": "string", "disabled": true } ] } ], "canSubmit": true, "unavailableReason": "string", "description": "string", "page": { "title": "string", "text": "string", "tables": [ { "title": "string", "headers": [ "string" ], "rows": [ [] ] } ], "links": [ { "label": "string", "url": "string" } ] }, "id": "string", "expiresAt": "2026-01-31T12:00:00Z", "submitLabel": "string", "storedAttachments": [ { "id": "string", "name": "string", "path": "string", "mimeType": "string", "size": 0, "sha256": "string", "url": "string", "available": true, "fieldName": "string" } ], "preselectStoredAttachments": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canSubmit": { "type": "boolean" }, "description": { "description": "Free-text description.", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "fields": { "items": { "properties": { "accept": { "type": "string" }, "disabled": { "type": "boolean" }, "label": { "description": "Human-readable label.", "type": "string" }, "multiple": { "type": "boolean" }, "name": { "description": "Display name.", "type": "string" }, "options": { "description": "Available options.", "items": { "properties": { "disabled": { "type": "boolean" }, "label": { "description": "Human-readable label.", "type": "string" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "value", "label" ], "type": "object" }, "type": "array" }, "required": { "type": "boolean" }, "type": { "description": "Record type.", "type": "string" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "name", "label", "type", "required", "disabled" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "operationKey": { "type": "string" }, "page": { "description": "Current page number (1-based).", "properties": { "links": { "items": { "properties": { "label": { "description": "Human-readable label.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "label", "url" ], "type": "object" }, "type": "array" }, "tables": { "items": { "properties": { "headers": { "items": { "type": "string" }, "type": "array" }, "rows": { "description": "The records on this page.", "items": { "type": "array" }, "type": "array" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "title", "headers", "rows" ], "type": "object" }, "type": "array" }, "text": { "description": "Text content.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "title", "text", "tables", "links" ], "type": [ "object", "null" ] }, "preparedId": { "type": "string" }, "preselectStoredAttachments": { "type": "boolean" }, "storedAttachments": { "description": "Stored documents that may be attached: the thread's draft attachments, and for a publicación the procedimiento's documents and draft files.", "items": { "properties": { "available": { "description": "false for a portal link whose file is not stored.", "type": "boolean" }, "fieldName": { "description": "Portal form field the file was uploaded to.", "type": "string" }, "id": { "description": "LiquidacionWorkspaceDocument id or draft file id.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Storage object path.", "type": "string" }, "sha256": { "type": [ "string", "null" ] }, "size": { "description": "Bytes.", "type": "integer" }, "url": { "description": "Portal URL of a document that was not downloaded.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "submitLabel": { "type": "string" }, "title": { "description": "Title.", "type": "string" }, "unavailableReason": { "type": "string" } }, "required": [ "preparedId", "operationKey", "title", "fields", "canSubmit", "unavailableReason" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidacion portal form", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/portal/get-liquidacion-workspace": { "post": { "description": "Get liquidacion workspace\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-get-liquidacion-workspace", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "permissions": { "canSync": true, "canPrepare": true, "canSubmit": true, "canReview": true, "canAnalyze": true }, "threads": [ { "id": "string", "causaBcId": "string", "rol": "string", "nombre": "string", "subject": "string", "state": "RECEIVED", "lastResponseAt": "2026-01-31T12:00:00Z", "lastSubstantiveAt": "2026-01-31T12:00:00Z", "receivedAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "resourceId": "string", "canReply": true, "messages": [ { "id": "string", "direction": "string", "subject": "string", "body": "string", "sender": "string", "date": "2026-01-31T12:00:00Z", "state": "string", "attachments": [ { "id": "string", "name": "string", "path": "string", "mimeType": "string", "size": 0, "sha256": "string", "url": "string", "available": true, "fieldName": "string" } ] } ], "requirements": [ { "id": "string", "_id": "string", "orgId": "string", "cbcId": "string", "threadId": "string", "sourceKey": "string", "title": "string", "instruction": "string", "explanation": "string", "nextAction": "string", "legalBasis": "string", "proofDescription": "string", "dueDate": "string", "dueVerified": true, "dueDateEstimated": true, "state": "PENDING", "evidence": [ { "id": "string", "title": "string", "file": { "id": "string", "name": "string", "path": "string", "mimeType": "string" }, "page": 0, "threadId": "string", "quote": "string" } ], "evidenceHash": "string", "assignedUserIds": [ "string" ], "taskId": "string", "reviewNote": "string", "reviewedById": "string", "reviewedAt": "string", "reviewHistory": [ { "state": "string", "note": "string", "evidenceIds": [ "string" ], "userId": "string", "at": "2026-01-31T12:00:00Z", "instructionDueDate": "string", "confirmDeadline": true } ], "cAt": "string", "uAt": "string" } ] } ], "requirements": [ { "id": "string", "_id": "string", "orgId": "string", "cbcId": "string", "threadId": "string", "sourceKey": "string", "title": "string", "instruction": "string", "explanation": "string", "nextAction": "string", "legalBasis": "string", "proofDescription": "string", "dueDate": "string", "dueVerified": true, "dueDateEstimated": true, "state": "PENDING", "evidence": [ { "id": "string", "title": "string", "file": { "id": "string", "name": "string", "path": "string", "mimeType": "string" }, "page": 0, "threadId": "string", "quote": "string" } ], "evidenceHash": "string", "assignedUserIds": [ "string" ], "taskId": "string", "reviewNote": "string", "reviewedById": "string", "reviewedAt": "string", "reviewHistory": [ { "state": "string", "note": "string", "evidenceIds": [ "string" ], "userId": "string", "at": "2026-01-31T12:00:00Z", "instructionDueDate": "string", "confirmDeadline": true } ], "cAt": "string", "uAt": "string" } ], "operations": [ { "key": "string", "label": "string", "available": true, "unavailableReason": "string" } ], "records": [ { "id": "string", "operationKey": "string", "title": "string", "state": "string", "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "page": { "title": "string", "text": "string", "tables": [ { "title": "string", "headers": [ "string" ], "rows": [ [] ] } ], "links": [ { "label": "string", "url": "string" } ] }, "detail": "string", "error": "string", "verified": true, "resourceId": "string", "canDelete": true, "canEdit": true, "attachments": [ { "id": "string", "name": "string", "path": "string", "mimeType": "string", "size": 0, "sha256": "string", "url": "string", "available": true, "fieldName": "string" } ] } ], "artifacts": [ { "id": "string", "title": "string", "kind": "string", "state": "string", "createdAt": "string", "body": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "contexto": "string", "sugerencia": "string", "opciones": [ { "tipo": "liquidador", "nombre": "string", "rut": "string", "patrocinaEnCausa": true, "ultimoUso": "string" } ], "permiteNuevo": true } ], "files": [ { "id": "string", "name": "string", "path": "string", "mimeType": "string" } ], "error": "string" } ], "members": [ { "id": "string", "name": "string" } ], "credentials": [ { "id": "string", "label": "string" } ], "warnings": [ "string" ], "causa": { "id": "string", "rol": "string", "nombre": "string", "tribunal": "string", "source": "L", "documentId": "string", "causaId": "string", "tipoProcedimiento": "string" }, "pagination": { "page": 0, "perPage": 0, "total": 0, "pageCount": 0, "search": "string" }, "summary": { "pending": 0, "overdue": 0, "awaitingReply": 0, "completed": 0 }, "analysisSummary": "string", "threadAliases": [ { "id": "string", "target": "string" } ], "analysisAt": "string", "analysisState": "string", "syncState": "string", "syncedAt": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "analysisAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "analysisState": { "description": "PENDING, QUEUED, STALE, READY or FAILED.", "type": "string" }, "analysisSummary": { "description": "Summary of the latest AI analysis.", "type": "string" }, "artifacts": { "description": "Last 40 drafts.", "items": { "properties": { "body": { "description": "Message text.", "type": "string" }, "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "error": { "type": [ "string", "null" ] }, "files": { "items": { "properties": { "id": { "description": "Artifact id plus \":docx\" or \":pdf\".", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Storage object path.", "type": "string" } }, "required": [ "id", "name", "path", "mimeType" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "missingFields": { "items": { "properties": { "clave": { "description": "Placeholder key.", "type": "string" }, "contexto": { "type": "string" }, "opciones": { "description": "Choices for a gap answered by picking one (the firma gap).", "items": { "properties": { "nombre": { "description": "Display name.", "type": "string" }, "patrocinaEnCausa": { "description": "The abogado already sponsors in this causa.", "type": "boolean" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "tipo": { "description": "Record type.", "enum": [ "liquidador", "abogado" ], "type": "string" }, "ultimoUso": { "description": "Last time the abogado appeared in the liquidador's escritos (YYYY-MM-DD).", "type": "string" } }, "required": [ "tipo" ], "type": "object" }, "type": "array" }, "permiteNuevo": { "description": "A new value may be entered besides the opciones.", "type": "boolean" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "sugerencia": { "description": "Suggested value.", "type": "string" } }, "required": [ "clave", "pregunta" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "kind", "state", "createdAt", "body", "missingFields", "files", "error" ], "type": "object" }, "type": "array" }, "causa": { "properties": { "causaId": { "description": "Linked PJUD causa id.", "type": [ "string", "null" ] }, "documentId": { "description": "Boletín Concursal procedimiento document id.", "type": "string" }, "id": { "description": "Boletín Concursal procedimiento id.", "type": "string" }, "nombre": { "description": "Debtor name.", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "source": { "description": "L = liquidador's own portal account, P = public Boletín feed.", "enum": [ "L", "P" ], "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] } }, "required": [ "id", "rol", "nombre", "tribunal", "source", "documentId", "causaId", "tipoProcedimiento" ], "type": "object" }, "credentials": { "description": "Enabled liquidador credentials (only for a liquidador procedimiento and a manager).", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Credential RUT.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "members": { "description": "Members.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "type": "array" }, "operations": { "items": { "properties": { "available": { "type": "boolean" }, "key": { "description": "Stable key.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "unavailableReason": { "type": "string" } }, "required": [ "key", "label", "available", "unavailableReason" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "page": { "description": "Current page number (1-based).", "type": "integer" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "perPage": { "description": "Page size.", "type": "integer" }, "search": { "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "page", "perPage", "total", "pageCount", "search" ], "type": "object" }, "permissions": { "properties": { "canAnalyze": { "type": "boolean" }, "canPrepare": { "type": "boolean" }, "canReview": { "type": "boolean" }, "canSubmit": { "type": "boolean" }, "canSync": { "type": "boolean" } }, "required": [ "canSync", "canPrepare", "canSubmit", "canReview", "canAnalyze" ], "type": "object" }, "records": { "description": "Last 100 portal operations.", "items": { "properties": { "archivedAt": { "type": [ "string", "null" ] }, "attachments": { "description": "Attachments.", "items": { "properties": { "available": { "description": "false for a portal link whose file is not stored.", "type": "boolean" }, "fieldName": { "description": "Portal form field the file was uploaded to.", "type": "string" }, "id": { "description": "LiquidacionWorkspaceDocument id or draft file id.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Storage object path.", "type": "string" }, "sha256": { "type": [ "string", "null" ] }, "size": { "description": "Bytes.", "type": "integer" }, "url": { "description": "Portal URL of a document that was not downloaded.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "canDelete": { "type": "boolean" }, "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "detail": { "description": "Result message.", "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "operationKey": { "type": "string" }, "page": { "description": "Portal page read back after the operation.", "properties": { "links": { "items": { "properties": { "label": { "description": "Human-readable label.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "label", "url" ], "type": "object" }, "type": "array" }, "tables": { "items": { "properties": { "headers": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "rows": { "description": "Rows of cell texts.", "items": { "type": "array" }, "type": "array" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "title", "headers", "rows" ], "type": "object" }, "type": "array" }, "text": { "description": "Text content.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "title", "text", "tables", "links" ], "type": [ "object", "null" ] }, "resourceId": { "description": "Portal id of the created resource.", "type": [ "string", "null" ] }, "state": { "description": "PREPARED, SUBMITTING, UNVERIFIED, CONFIRMED, FAILED...", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "updatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "id", "operationKey", "title", "state", "createdAt", "updatedAt", "archivedAt", "page", "detail", "error", "verified", "resourceId", "canDelete", "canEdit", "attachments" ], "type": "object" }, "type": "array" }, "requirements": { "items": { "properties": { "_id": { "description": "Same as id (raw column).", "type": "string" }, "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "cAt": { "description": "Created at (ISO 8601 without a zone offset).", "type": "string" }, "cbcId": { "description": "Procedimiento id.", "type": "string" }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "dueDateEstimated": { "description": "The due date is the analysis' estimate (not dueVerified).", "type": "boolean" }, "dueVerified": { "description": "A person confirmed the due date.", "type": "boolean" }, "evidence": { "description": "Sources the analysis cited.", "items": { "properties": { "file": { "description": "Stored document the evidence is in.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Path relative to the API host.", "type": "string" } }, "required": [ "id", "name", "path", "mimeType" ], "type": "object" }, "id": { "description": "Source reference, e.g. document:\u003cid\u003e:page:\u003cn\u003e or message:\u003cid\u003e.", "type": "string" }, "page": { "description": "Current page number (1-based).", "type": "integer" }, "quote": { "description": "Quoted passage supporting the requirement.", "type": "string" }, "threadId": { "type": [ "string", "null" ] }, "title": { "description": "Title.", "type": [ "string", "null" ] } }, "required": [ "id", "title", "quote" ], "type": "object" }, "type": "array" }, "evidenceHash": { "type": [ "string", "null" ] }, "explanation": { "description": "Same as instruction.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "instruction": { "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": [ "string", "null" ] }, "nextAction": { "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "proofDescription": { "type": [ "string", "null" ] }, "reviewHistory": { "description": "Every review, oldest first.", "items": { "properties": { "at": { "format": "date-time", "type": "string" }, "confirmDeadline": { "type": "boolean" }, "evidenceIds": { "items": { "type": "string" }, "type": "array" }, "instructionDueDate": { "type": [ "string", "null" ] }, "note": { "description": "Free-text note.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "state", "note", "evidenceIds", "userId", "at", "instructionDueDate", "confirmDeadline" ], "type": "object" }, "type": "array" }, "reviewNote": { "type": [ "string", "null" ] }, "reviewedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "reviewedById": { "type": [ "string", "null" ] }, "sourceKey": { "type": "string" }, "state": { "description": "Current state.", "enum": [ "PENDING", "PARTIAL", "FULFILLED", "NOT_APPLICABLE", "OBSERVED", "REQUIRES_REVIEW" ], "type": "string" }, "taskId": { "description": "Task id.", "type": [ "string", "null" ] }, "threadId": { "description": "Communication thread the requirement came from.", "type": [ "string", "null" ] }, "title": { "description": "Title.", "type": "string" }, "uAt": { "description": "Updated at (ISO 8601 without a zone offset).", "type": "string" } }, "required": [ "id", "_id", "orgId", "cbcId", "threadId", "sourceKey", "title", "instruction", "explanation", "nextAction", "legalBasis", "proofDescription", "dueDate", "dueVerified", "dueDateEstimated", "state", "evidence", "evidenceHash", "assignedUserIds", "taskId", "reviewNote", "reviewedById", "reviewedAt", "reviewHistory", "cAt", "uAt" ], "type": "object" }, "type": "array" }, "summary": { "description": "Requirement totals over the accessible scope.", "properties": { "awaitingReply": { "type": "integer" }, "completed": { "type": "integer" }, "overdue": { "type": "integer" }, "pending": { "description": "Number pending.", "type": "integer" } }, "required": [ "pending", "overdue", "awaitingReply", "completed" ], "type": "object" }, "syncState": { "type": "string" }, "syncedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "threadAliases": { "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "target": { "description": "Thread it was manually linked to.", "type": [ "string", "null" ] } }, "required": [ "id", "target" ], "type": "object" }, "type": "array" }, "threads": { "items": { "properties": { "canReply": { "type": "boolean" }, "causaBcId": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "lastResponseAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastSubstantiveAt": { "format": "date-time", "type": [ "string", "null" ] }, "messages": { "description": "Chat messages, oldest first.", "items": { "properties": { "attachments": { "description": "Attachments.", "items": { "properties": { "available": { "description": "false for a portal link whose file is not stored.", "type": "boolean" }, "fieldName": { "description": "Portal form field the file was uploaded to.", "type": "string" }, "id": { "description": "LiquidacionWorkspaceDocument id or draft file id.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Storage object path.", "type": "string" }, "sha256": { "type": [ "string", "null" ] }, "size": { "description": "Bytes.", "type": "integer" }, "url": { "description": "Portal URL of a document that was not downloaded.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "body": { "description": "Message text.", "type": "string" }, "date": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "direction": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "sender": { "type": [ "string", "null" ] }, "state": { "description": "Current state.", "type": "string" }, "subject": { "type": [ "string", "null" ] } }, "required": [ "id", "direction", "subject", "body", "sender", "date", "state", "attachments" ], "type": "object" }, "type": "array" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "receivedAt": { "format": "date-time", "type": [ "string", "null" ] }, "requirements": { "description": "Requirements raised by this thread.", "items": { "properties": { "_id": { "description": "Same as id (raw column).", "type": "string" }, "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "cAt": { "description": "Created at (ISO 8601 without a zone offset).", "type": "string" }, "cbcId": { "description": "Procedimiento id.", "type": "string" }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "dueDateEstimated": { "description": "The due date is the analysis' estimate (not dueVerified).", "type": "boolean" }, "dueVerified": { "description": "A person confirmed the due date.", "type": "boolean" }, "evidence": { "description": "Sources the analysis cited.", "items": { "properties": { "file": { "description": "Stored document the evidence is in.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Path relative to the API host.", "type": "string" } }, "required": [ "id", "name", "path", "mimeType" ], "type": "object" }, "id": { "description": "Source reference, e.g. document:\u003cid\u003e:page:\u003cn\u003e or message:\u003cid\u003e.", "type": "string" }, "page": { "description": "Current page number (1-based).", "type": "integer" }, "quote": { "description": "Quoted passage supporting the requirement.", "type": "string" }, "threadId": { "type": [ "string", "null" ] }, "title": { "description": "Title.", "type": [ "string", "null" ] } }, "required": [ "id", "title", "quote" ], "type": "object" }, "type": "array" }, "evidenceHash": { "type": [ "string", "null" ] }, "explanation": { "description": "Same as instruction.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "instruction": { "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": [ "string", "null" ] }, "nextAction": { "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "proofDescription": { "type": [ "string", "null" ] }, "reviewHistory": { "description": "Every review, oldest first.", "items": { "properties": { "at": { "format": "date-time", "type": "string" }, "confirmDeadline": { "type": "boolean" }, "evidenceIds": { "items": { "type": "string" }, "type": "array" }, "instructionDueDate": { "type": [ "string", "null" ] }, "note": { "description": "Free-text note.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "state", "note", "evidenceIds", "userId", "at", "instructionDueDate", "confirmDeadline" ], "type": "object" }, "type": "array" }, "reviewNote": { "type": [ "string", "null" ] }, "reviewedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "reviewedById": { "type": [ "string", "null" ] }, "sourceKey": { "type": "string" }, "state": { "description": "Current state.", "enum": [ "PENDING", "PARTIAL", "FULFILLED", "NOT_APPLICABLE", "OBSERVED", "REQUIRES_REVIEW" ], "type": "string" }, "taskId": { "description": "Task id.", "type": [ "string", "null" ] }, "threadId": { "description": "Communication thread the requirement came from.", "type": [ "string", "null" ] }, "title": { "description": "Title.", "type": "string" }, "uAt": { "description": "Updated at (ISO 8601 without a zone offset).", "type": "string" } }, "required": [ "id", "_id", "orgId", "cbcId", "threadId", "sourceKey", "title", "instruction", "explanation", "nextAction", "legalBasis", "proofDescription", "dueDate", "dueVerified", "dueDateEstimated", "state", "evidence", "evidenceHash", "assignedUserIds", "taskId", "reviewNote", "reviewedById", "reviewedAt", "reviewHistory", "cAt", "uAt" ], "type": "object" }, "type": "array" }, "resourceId": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "enum": [ "RECEIVED", "SENT", "POR_RESPONDER" ], "type": "string" }, "subject": { "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "causaBcId", "rol", "nombre", "subject", "state", "lastResponseAt", "lastSubstantiveAt", "receivedAt", "updatedAt", "resourceId", "canReply", "messages", "requirements" ], "type": "object" }, "type": "array" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "permissions", "threads", "requirements", "operations", "records", "artifacts", "members", "credentials", "warnings", "summary" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidacion workspace", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/portal/get-liquidacion-workspace-document-url": { "post": { "description": "Get liquidacion workspace document url\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-get-liquidacion-workspace-document-url", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "previewUrl": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "previewUrl": { "description": "Short-lived URL to preview the file.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidacion workspace document url", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/portal/review-liquidacion-communication-link": { "post": { "description": "Review liquidacion communication link\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-review-liquidacion-communication-link", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "state": "string", "targetThreadId": "string", "message": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "message": { "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "targetThreadId": { "type": "string" } }, "required": [ "state", "targetThreadId", "message" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Review liquidacion communication link", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/portal/review-liquidacion-requirement": { "post": { "description": "Review liquidacion requirement\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-review-liquidacion-requirement", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "state": "string", "taskId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" } }, "required": [ "state", "taskId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Review liquidacion requirement", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/portal/save-liquidacion-communication-draft": { "post": { "description": "Save liquidacion communication draft\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-save-liquidacion-communication-draft", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "subject": "string", "body": "string", "attachments": [ { "id": "string", "name": "string", "mimeType": "string", "size": 0, "path": "string", "sha256": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "attachments": { "description": "Attachments.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Path relative to the API host.", "type": "string" }, "sha256": { "type": "string" }, "size": { "type": "integer" } }, "required": [ "id", "name", "mimeType", "size", "path", "sha256" ], "type": "object" }, "type": "array" }, "body": { "description": "Message text.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "subject": { "type": "string" } }, "required": [ "id", "subject", "body", "attachments" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save liquidacion communication draft", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/portal/save-liquidacion-draft": { "post": { "description": "Save liquidacion draft\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-save-liquidacion-draft", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "title": "string", "kind": "string", "state": "DRAFT", "body": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "contexto": "string", "sugerencia": "string", "opciones": [ { "tipo": "liquidador", "nombre": "string", "rut": "string", "patrocinaEnCausa": true, "ultimoUso": "string" } ], "permiteNuevo": true } ], "files": [ { "id": "string", "name": "string", "path": "string", "mimeType": "string" } ], "error": "string" } }, "schema": { "properties": { "data": { "description": "The new version of the draft.", "properties": { "body": { "description": "Draft text.", "type": "string" }, "error": { "description": "Export problem, empty when none.", "type": "string" }, "files": { "items": { "properties": { "id": { "description": "Artifact id plus \":docx\" or \":pdf\".", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Storage object path.", "type": "string" } }, "required": [ "id", "name", "path", "mimeType" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Draft kind, e.g. judicial or administrative.", "type": "string" }, "missingFields": { "description": "Data the draft still lacks.", "items": { "properties": { "clave": { "description": "Placeholder key.", "type": "string" }, "contexto": { "type": "string" }, "opciones": { "description": "Choices for a gap answered by picking one (the firma gap).", "items": { "properties": { "nombre": { "description": "Display name.", "type": "string" }, "patrocinaEnCausa": { "description": "The abogado already sponsors in this causa.", "type": "boolean" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "tipo": { "description": "Record type.", "enum": [ "liquidador", "abogado" ], "type": "string" }, "ultimoUso": { "description": "Last time the abogado appeared in the liquidador's escritos (YYYY-MM-DD).", "type": "string" } }, "required": [ "tipo" ], "type": "object" }, "type": "array" }, "permiteNuevo": { "description": "A new value may be entered besides the opciones.", "type": "boolean" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "sugerencia": { "description": "Suggested value.", "type": "string" } }, "required": [ "clave", "pregunta" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state.", "enum": [ "DRAFT", "EXPORT_PENDING" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "kind", "state", "body", "missingFields", "files", "error" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save liquidacion draft", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/portal/send-liquidacion-operation": { "post": { "description": "Send liquidacion operation\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-send-liquidacion-operation", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "recordId": "string", "state": "string", "verified": true, "message": "string", "portalId": "string", "portalState": "string", "page": { "title": "string", "text": "string", "tables": [ { "title": "string", "headers": [ "string" ], "rows": [ [] ] } ], "links": [ { "label": "string", "url": "string" } ] } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "message": { "type": "string" }, "page": { "description": "Current page number (1-based).", "properties": { "links": { "items": { "properties": { "label": { "description": "Human-readable label.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "label", "url" ], "type": "object" }, "type": "array" }, "tables": { "items": { "properties": { "headers": { "items": { "type": "string" }, "type": "array" }, "rows": { "description": "The records on this page.", "items": { "type": "array" }, "type": "array" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "title", "headers", "rows" ], "type": "object" }, "type": "array" }, "text": { "description": "Text content.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "title", "text", "tables", "links" ], "type": [ "object", "null" ] }, "portalId": { "type": "string" }, "portalState": { "type": "string" }, "recordId": { "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "recordId", "state", "verified", "message" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send liquidacion operation", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/portal/sync-liquidacion-workspace": { "post": { "description": "Sync liquidacion workspace\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-portal-sync-liquidacion-workspace", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "state": "string", "queued": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "queued": { "type": "integer" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "state", "queued" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Sync liquidacion workspace", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/queries/export-liquidations-review": { "post": { "description": "Export liquidaciones review\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-export-liquidations-review", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "fileName": "string", "mimeType": "string", "base64": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "base64": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" } }, "required": [ "fileName", "mimeType", "base64" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Export liquidaciones review", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidacion-cierre": { "post": { "description": "Closing (cierre) report for one causa.\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidacion-cierre", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "source": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "source": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "checklist": { "impedimentos": [ { "id": "string", "ruleKey": "string", "title": "string", "state": "string", "severity": "string", "explanation": "string", "reviewedState": "string", "effectiveState": "string", "taskId": "string", "order": 0, "phase": "string", "legalBasis": "string", "plazo": "string", "closingRole": "string", "nextAction": "string", "actor": "string", "evidence": { "source": "L", "items": [ "string" ], "references": [ { "id": "string", "source": "publications", "title": "string", "date": "string", "evidenceCandidate": true } ] }, "reviewNote": "string", "reviewedAt": "2026-01-31T12:00:00Z", "appliesToFamily": true, "task": { "id": "string", "title": "string", "status": "string", "priority": "string", "dueDate": "string", "findingId": "string", "assignedUserIds": [ "string" ] } } ], "hitosPendientes": [ { "id": "string", "ruleKey": "string", "title": "string", "state": "string", "severity": "string", "explanation": "string", "reviewedState": "string", "effectiveState": "string", "taskId": "string", "order": 0, "phase": "string", "legalBasis": "string", "plazo": "string", "closingRole": "string", "nextAction": "string", "actor": "string", "evidence": { "source": "L", "items": [ "string" ], "references": [ { "id": "string", "source": "publications", "title": "string", "date": "string", "evidenceCandidate": true } ] }, "reviewNote": "string", "reviewedAt": "2026-01-31T12:00:00Z", "appliesToFamily": true, "task": { "id": "string", "title": "string", "status": "string", "priority": "string", "dueDate": "string", "findingId": "string", "assignedUserIds": [ "string" ] } } ], "certificaciones": [ { "id": "string", "ruleKey": "string", "title": "string", "state": "string", "severity": "string", "explanation": "string", "reviewedState": "string", "effectiveState": "string", "taskId": "string", "order": 0, "phase": "string", "legalBasis": "string", "plazo": "string", "closingRole": "string", "nextAction": "string", "actor": "string", "evidence": { "source": "L", "items": [ "string" ], "references": [ { "id": "string", "source": "publications", "title": "string", "date": "string", "evidenceCandidate": true } ] }, "reviewNote": "string", "reviewedAt": "2026-01-31T12:00:00Z", "appliesToFamily": true, "task": { "id": "string", "title": "string", "status": "string", "priority": "string", "dueDate": "string", "findingId": "string", "assignedUserIds": [ "string" ] } } ], "completados": [ { "id": "string", "ruleKey": "string", "title": "string", "state": "string", "severity": "string", "explanation": "string", "reviewedState": "string", "effectiveState": "string", "taskId": "string", "order": 0, "phase": "string", "legalBasis": "string", "plazo": "string", "closingRole": "string", "nextAction": "string", "actor": "string", "evidence": { "source": "L", "items": [ "string" ], "references": [ { "id": "string", "source": "publications", "title": "string", "date": "string", "evidenceCandidate": true } ] }, "reviewNote": "string", "reviewedAt": "2026-01-31T12:00:00Z", "appliesToFamily": true, "task": { "id": "string", "title": "string", "status": "string", "priority": "string", "dueDate": "string", "findingId": "string", "assignedUserIds": [ "string" ] } } ], "noAplica": [ { "id": "string", "ruleKey": "string", "title": "string", "state": "string", "severity": "string", "explanation": "string", "reviewedState": "string", "effectiveState": "string", "taskId": "string", "order": 0, "phase": "string", "legalBasis": "string", "plazo": "string", "closingRole": "string", "nextAction": "string", "actor": "string", "evidence": { "source": "L", "items": [ "string" ], "references": [ { "id": "string", "source": "publications", "title": "string", "date": "string", "evidenceCandidate": true } ] }, "reviewNote": "string", "reviewedAt": "2026-01-31T12:00:00Z", "appliesToFamily": true, "task": { "id": "string", "title": "string", "status": "string", "priority": "string", "dueDate": "string", "findingId": "string", "assignedUserIds": [ "string" ] } } ], "futuros": [ { "id": "string", "ruleKey": "string", "title": "string", "state": "string", "severity": "string", "explanation": "string", "reviewedState": "string", "effectiveState": "string", "taskId": "string", "order": 0, "phase": "string", "legalBasis": "string", "plazo": "string", "closingRole": "string", "nextAction": "string", "actor": "string", "evidence": { "source": "L", "items": [ "string" ], "references": [ { "id": "string", "source": "publications", "title": "string", "date": "string", "evidenceCandidate": true } ] }, "reviewNote": "string", "reviewedAt": "2026-01-31T12:00:00Z", "appliesToFamily": true, "task": { "id": "string", "title": "string", "status": "string", "priority": "string", "dueDate": "string", "findingId": "string", "assignedUserIds": [ "string" ] } } ], "total": 0, "covered": 0 }, "familia": "string", "nextStep": { "ruleKey": "string", "title": "string", "phase": "string", "legalBasis": "string", "plazo": "string", "action": "string", "actor": "string" }, "plazos": [ { "key": "string", "title": "string", "legalBasis": "string", "note": "string", "baseEvent": "string", "baseDate": "2026-01-31T12:00:00Z", "dueDate": "2026-01-31T12:00:00Z", "days": 0, "businessDays": true, "dayRule": "string", "dayRuleLabel": "string", "approx": true, "status": "string", "doneEvent": "string", "doneDate": "2026-01-31T12:00:00Z", "daysLeft": 0 } ], "bienesConciliacion": { "complete": true, "pendingBienes": 0, "pendingEvents": 0, "pendingRendiciones": 0, "pendingDocs": 0, "reasons": [ "string" ] }, "cuentaFinalPreparacion": { "reference": "string", "state": "PREPARACION_PARCIAL", "incomeAccounts": [ { "code": "string", "label": "string", "amount": 0 } ], "expenseAccounts": [ { "code": "string", "label": "string", "amount": 0 } ], "verifiedRenditions": 0, "pendingRenditions": 0, "nonCLPRenditions": 0, "publishedBalancedProvisionalPeriods": 0, "provisionalPeriods": [ "string" ], "pendingProvisionalPeriods": [ "string" ], "accountingWarnings": [ { "code": "string", "label": "string", "provisionalAmount": 0, "renditionAmount": 0, "message": "string" } ], "knownFigures": [ { "code": "string", "label": "string", "amount": 0, "currency": "string", "source": "string" } ], "requiredManualInputs": [ "string" ], "amountsOmitted": 0, "warning": "string" }, "cuentasFinalesMotivos": [ "string" ], "cuentasFinalesHabilitadas": true, "adminStatus": "CERRADO", "ageApprox": true, "ageDays": 0, "dueSoonCount": 0, "fechaUltimaGestion": "string", "idleDays": 0, "idleSource": "documented_review", "lastSubstantiveAt": "string", "legalStatus": "TERMINO_FIRME", "nextDueDate": "string", "nextRequirement": { "id": "string", "title": "string", "action": "string", "state": "string", "dueDate": "string" }, "nextTask": { "id": "string", "title": "string", "action": "string", "dueDate": "string" }, "openTasks": 0, "overdueCount": 0, "pendingInstructions": 0, "reportVerdict": "BLOQUEADA", "rolYear": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "adminStatus": { "enum": [ "CERRADO", "INSTRUCCIONES_PENDIENTES", "POR_REVISAR" ], "type": "string" }, "ageApprox": { "description": "ageDays is estimated from the rol year.", "type": "boolean" }, "ageDays": { "description": "Days since the procedimiento started (fecha, or 1 January of the rol year).", "type": [ "integer", "null" ] }, "bienesConciliacion": { "description": "Bienes reconciliation completeness (liquidador procedimientos only).", "properties": { "complete": { "type": "boolean" }, "pendingBienes": { "type": "integer" }, "pendingDocs": { "type": "integer" }, "pendingEvents": { "type": "integer" }, "pendingRendiciones": { "type": "integer" }, "reasons": { "items": { "type": "string" }, "type": "array" } }, "required": [ "complete", "pendingBienes", "pendingEvents", "pendingRendiciones", "pendingDocs", "reasons" ], "type": "object" }, "checklist": { "properties": { "certificaciones": { "items": { "properties": { "actor": { "type": "string" }, "appliesToFamily": { "type": "boolean" }, "closingRole": { "description": "hito, impedimento, certificacion or datos.", "type": "string" }, "effectiveState": { "description": "Reviewed state when set, else the evaluated state.", "type": "string" }, "evidence": { "description": "Supporting evidence.", "properties": { "items": { "description": "The records returned.", "items": { "type": "string" }, "type": "array" }, "references": { "description": "References.", "items": { "properties": { "date": { "description": "Publication or action date as stored (timestamp string).", "type": [ "string", "null" ] }, "evidenceCandidate": { "description": "The movement reads as evidence for the rule.", "type": "boolean" }, "id": { "description": "Publication or action id.", "type": "string" }, "source": { "description": "Where the record came from.", "enum": [ "publications", "actions" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "title", "date", "evidenceCandidate" ], "type": "object" }, "type": "array" }, "source": { "description": "Source of the procedimiento the finding was evaluated on.", "enum": [ "L", "P" ], "type": "string" } }, "required": [ "source", "items", "references" ], "type": "object" }, "explanation": { "description": "Explanation.", "type": "string" }, "id": { "description": "Finding id.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "nextAction": { "type": "string" }, "order": { "description": "Position of the hito in procedure order.", "type": "integer" }, "phase": { "type": "string" }, "plazo": { "type": "string" }, "reviewNote": { "type": "string" }, "reviewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "reviewedState": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "severity": { "description": "Severity.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "task": { "description": "Open task created from this finding.", "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "findingId": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "priority": { "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "status", "priority", "dueDate", "findingId", "assignedUserIds" ], "type": "object" }, "taskId": { "description": "Task id.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "ruleKey", "title", "state", "severity", "explanation", "reviewedState", "effectiveState", "taskId", "order", "phase", "legalBasis", "plazo", "closingRole", "nextAction", "actor", "evidence", "reviewNote", "reviewedAt", "appliesToFamily" ], "type": "object" }, "type": "array" }, "completados": { "items": { "properties": { "actor": { "type": "string" }, "appliesToFamily": { "type": "boolean" }, "closingRole": { "description": "hito, impedimento, certificacion or datos.", "type": "string" }, "effectiveState": { "description": "Reviewed state when set, else the evaluated state.", "type": "string" }, "evidence": { "description": "Supporting evidence.", "properties": { "items": { "description": "The records returned.", "items": { "type": "string" }, "type": "array" }, "references": { "description": "References.", "items": { "properties": { "date": { "description": "Publication or action date as stored (timestamp string).", "type": [ "string", "null" ] }, "evidenceCandidate": { "description": "The movement reads as evidence for the rule.", "type": "boolean" }, "id": { "description": "Publication or action id.", "type": "string" }, "source": { "description": "Where the record came from.", "enum": [ "publications", "actions" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "title", "date", "evidenceCandidate" ], "type": "object" }, "type": "array" }, "source": { "description": "Source of the procedimiento the finding was evaluated on.", "enum": [ "L", "P" ], "type": "string" } }, "required": [ "source", "items", "references" ], "type": "object" }, "explanation": { "description": "Explanation.", "type": "string" }, "id": { "description": "Finding id.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "nextAction": { "type": "string" }, "order": { "description": "Position of the hito in procedure order.", "type": "integer" }, "phase": { "type": "string" }, "plazo": { "type": "string" }, "reviewNote": { "type": "string" }, "reviewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "reviewedState": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "severity": { "description": "Severity.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "task": { "description": "Open task created from this finding.", "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "findingId": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "priority": { "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "status", "priority", "dueDate", "findingId", "assignedUserIds" ], "type": "object" }, "taskId": { "description": "Task id.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "ruleKey", "title", "state", "severity", "explanation", "reviewedState", "effectiveState", "taskId", "order", "phase", "legalBasis", "plazo", "closingRole", "nextAction", "actor", "evidence", "reviewNote", "reviewedAt", "appliesToFamily" ], "type": "object" }, "type": "array" }, "covered": { "type": "integer" }, "futuros": { "items": { "properties": { "actor": { "type": "string" }, "appliesToFamily": { "type": "boolean" }, "closingRole": { "description": "hito, impedimento, certificacion or datos.", "type": "string" }, "effectiveState": { "description": "Reviewed state when set, else the evaluated state.", "type": "string" }, "evidence": { "description": "Supporting evidence.", "properties": { "items": { "description": "The records returned.", "items": { "type": "string" }, "type": "array" }, "references": { "description": "References.", "items": { "properties": { "date": { "description": "Publication or action date as stored (timestamp string).", "type": [ "string", "null" ] }, "evidenceCandidate": { "description": "The movement reads as evidence for the rule.", "type": "boolean" }, "id": { "description": "Publication or action id.", "type": "string" }, "source": { "description": "Where the record came from.", "enum": [ "publications", "actions" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "title", "date", "evidenceCandidate" ], "type": "object" }, "type": "array" }, "source": { "description": "Source of the procedimiento the finding was evaluated on.", "enum": [ "L", "P" ], "type": "string" } }, "required": [ "source", "items", "references" ], "type": "object" }, "explanation": { "description": "Explanation.", "type": "string" }, "id": { "description": "Finding id.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "nextAction": { "type": "string" }, "order": { "description": "Position of the hito in procedure order.", "type": "integer" }, "phase": { "type": "string" }, "plazo": { "type": "string" }, "reviewNote": { "type": "string" }, "reviewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "reviewedState": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "severity": { "description": "Severity.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "task": { "description": "Open task created from this finding.", "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "findingId": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "priority": { "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "status", "priority", "dueDate", "findingId", "assignedUserIds" ], "type": "object" }, "taskId": { "description": "Task id.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "ruleKey", "title", "state", "severity", "explanation", "reviewedState", "effectiveState", "taskId", "order", "phase", "legalBasis", "plazo", "closingRole", "nextAction", "actor", "evidence", "reviewNote", "reviewedAt", "appliesToFamily" ], "type": "object" }, "type": "array" }, "hitosPendientes": { "items": { "properties": { "actor": { "type": "string" }, "appliesToFamily": { "type": "boolean" }, "closingRole": { "description": "hito, impedimento, certificacion or datos.", "type": "string" }, "effectiveState": { "description": "Reviewed state when set, else the evaluated state.", "type": "string" }, "evidence": { "description": "Supporting evidence.", "properties": { "items": { "description": "The records returned.", "items": { "type": "string" }, "type": "array" }, "references": { "description": "References.", "items": { "properties": { "date": { "description": "Publication or action date as stored (timestamp string).", "type": [ "string", "null" ] }, "evidenceCandidate": { "description": "The movement reads as evidence for the rule.", "type": "boolean" }, "id": { "description": "Publication or action id.", "type": "string" }, "source": { "description": "Where the record came from.", "enum": [ "publications", "actions" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "title", "date", "evidenceCandidate" ], "type": "object" }, "type": "array" }, "source": { "description": "Source of the procedimiento the finding was evaluated on.", "enum": [ "L", "P" ], "type": "string" } }, "required": [ "source", "items", "references" ], "type": "object" }, "explanation": { "description": "Explanation.", "type": "string" }, "id": { "description": "Finding id.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "nextAction": { "type": "string" }, "order": { "description": "Position of the hito in procedure order.", "type": "integer" }, "phase": { "type": "string" }, "plazo": { "type": "string" }, "reviewNote": { "type": "string" }, "reviewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "reviewedState": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "severity": { "description": "Severity.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "task": { "description": "Open task created from this finding.", "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "findingId": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "priority": { "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "status", "priority", "dueDate", "findingId", "assignedUserIds" ], "type": "object" }, "taskId": { "description": "Task id.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "ruleKey", "title", "state", "severity", "explanation", "reviewedState", "effectiveState", "taskId", "order", "phase", "legalBasis", "plazo", "closingRole", "nextAction", "actor", "evidence", "reviewNote", "reviewedAt", "appliesToFamily" ], "type": "object" }, "type": "array" }, "impedimentos": { "items": { "properties": { "actor": { "type": "string" }, "appliesToFamily": { "type": "boolean" }, "closingRole": { "description": "hito, impedimento, certificacion or datos.", "type": "string" }, "effectiveState": { "description": "Reviewed state when set, else the evaluated state.", "type": "string" }, "evidence": { "description": "Supporting evidence.", "properties": { "items": { "description": "The records returned.", "items": { "type": "string" }, "type": "array" }, "references": { "description": "References.", "items": { "properties": { "date": { "description": "Publication or action date as stored (timestamp string).", "type": [ "string", "null" ] }, "evidenceCandidate": { "description": "The movement reads as evidence for the rule.", "type": "boolean" }, "id": { "description": "Publication or action id.", "type": "string" }, "source": { "description": "Where the record came from.", "enum": [ "publications", "actions" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "title", "date", "evidenceCandidate" ], "type": "object" }, "type": "array" }, "source": { "description": "Source of the procedimiento the finding was evaluated on.", "enum": [ "L", "P" ], "type": "string" } }, "required": [ "source", "items", "references" ], "type": "object" }, "explanation": { "description": "Explanation.", "type": "string" }, "id": { "description": "Finding id.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "nextAction": { "type": "string" }, "order": { "description": "Position of the hito in procedure order.", "type": "integer" }, "phase": { "type": "string" }, "plazo": { "type": "string" }, "reviewNote": { "type": "string" }, "reviewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "reviewedState": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "severity": { "description": "Severity.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "task": { "description": "Open task created from this finding.", "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "findingId": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "priority": { "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "status", "priority", "dueDate", "findingId", "assignedUserIds" ], "type": "object" }, "taskId": { "description": "Task id.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "ruleKey", "title", "state", "severity", "explanation", "reviewedState", "effectiveState", "taskId", "order", "phase", "legalBasis", "plazo", "closingRole", "nextAction", "actor", "evidence", "reviewNote", "reviewedAt", "appliesToFamily" ], "type": "object" }, "type": "array" }, "noAplica": { "items": { "properties": { "actor": { "type": "string" }, "appliesToFamily": { "type": "boolean" }, "closingRole": { "description": "hito, impedimento, certificacion or datos.", "type": "string" }, "effectiveState": { "description": "Reviewed state when set, else the evaluated state.", "type": "string" }, "evidence": { "description": "Supporting evidence.", "properties": { "items": { "description": "The records returned.", "items": { "type": "string" }, "type": "array" }, "references": { "description": "References.", "items": { "properties": { "date": { "description": "Publication or action date as stored (timestamp string).", "type": [ "string", "null" ] }, "evidenceCandidate": { "description": "The movement reads as evidence for the rule.", "type": "boolean" }, "id": { "description": "Publication or action id.", "type": "string" }, "source": { "description": "Where the record came from.", "enum": [ "publications", "actions" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "title", "date", "evidenceCandidate" ], "type": "object" }, "type": "array" }, "source": { "description": "Source of the procedimiento the finding was evaluated on.", "enum": [ "L", "P" ], "type": "string" } }, "required": [ "source", "items", "references" ], "type": "object" }, "explanation": { "description": "Explanation.", "type": "string" }, "id": { "description": "Finding id.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "nextAction": { "type": "string" }, "order": { "description": "Position of the hito in procedure order.", "type": "integer" }, "phase": { "type": "string" }, "plazo": { "type": "string" }, "reviewNote": { "type": "string" }, "reviewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "reviewedState": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "severity": { "description": "Severity.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "task": { "description": "Open task created from this finding.", "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "findingId": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "priority": { "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "status", "priority", "dueDate", "findingId", "assignedUserIds" ], "type": "object" }, "taskId": { "description": "Task id.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "ruleKey", "title", "state", "severity", "explanation", "reviewedState", "effectiveState", "taskId", "order", "phase", "legalBasis", "plazo", "closingRole", "nextAction", "actor", "evidence", "reviewNote", "reviewedAt", "appliesToFamily" ], "type": "object" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "impedimentos", "hitosPendientes", "certificaciones", "completados", "noAplica", "futuros", "total", "covered" ], "type": "object" }, "cuentaFinalPreparacion": { "description": "Cuenta Final de Administración preparation (liquidador procedimientos only).", "properties": { "accountingWarnings": { "items": { "properties": { "code": { "description": "Short code.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "message": { "type": "string" }, "provisionalAmount": { "type": "integer" }, "renditionAmount": { "type": "integer" } }, "required": [ "code", "label", "provisionalAmount", "renditionAmount", "message" ], "type": "object" }, "type": "array" }, "amountsOmitted": { "description": "Non-CLP renditions left out of the totals.", "type": "integer" }, "expenseAccounts": { "items": { "properties": { "amount": { "description": "CLP; null when no confirmed source.", "type": [ "integer", "null" ] }, "code": { "description": "Short code.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "code", "label", "amount" ], "type": "object" }, "type": "array" }, "incomeAccounts": { "items": { "properties": { "amount": { "description": "CLP; null when no confirmed source.", "type": [ "integer", "null" ] }, "code": { "description": "Short code.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "code", "label", "amount" ], "type": "object" }, "type": "array" }, "knownFigures": { "items": { "properties": { "amount": { "description": "Amount.", "type": [ "integer", "null" ] }, "code": { "description": "Short code.", "type": "string" }, "currency": { "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "source": { "description": "Where the record came from.", "type": "string" } }, "required": [ "code", "label", "amount", "currency", "source" ], "type": "object" }, "type": "array" }, "nonCLPRenditions": { "type": "integer" }, "pendingProvisionalPeriods": { "items": { "type": "string" }, "type": "array" }, "pendingRenditions": { "type": "integer" }, "provisionalPeriods": { "description": "Published, balanced cuenta provisoria periods (YYYY-MM).", "items": { "type": "string" }, "type": [ "array", "null" ] }, "publishedBalancedProvisionalPeriods": { "type": "integer" }, "reference": { "type": "string" }, "requiredManualInputs": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "enum": [ "PREPARACION_PARCIAL" ], "type": "string" }, "verifiedRenditions": { "type": "integer" }, "warning": { "type": "string" } }, "required": [ "reference", "state", "incomeAccounts", "expenseAccounts", "verifiedRenditions", "pendingRenditions", "nonCLPRenditions", "publishedBalancedProvisionalPeriods", "provisionalPeriods", "pendingProvisionalPeriods", "accountingWarnings", "knownFigures", "requiredManualInputs", "amountsOmitted", "warning" ], "type": "object" }, "cuentasFinalesHabilitadas": { "type": "boolean" }, "cuentasFinalesMotivos": { "items": { "type": "string" }, "type": "array" }, "dueSoonCount": { "description": "Due within seven days.", "type": "integer" }, "familia": { "type": "string" }, "fechaUltimaGestion": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "idleDays": { "description": "Days since the last substantive gestión.", "type": [ "integer", "null" ] }, "idleSource": { "enum": [ "documented_review", "communication", "publication" ], "type": [ "string", "null" ] }, "lastSubstantiveAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "legalStatus": { "enum": [ "TERMINO_FIRME", "TERMINO_PUBLICADO", "CUENTA_APROBADA", "EN_TRAMITACION" ], "type": "string" }, "nextDueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "nextRequirement": { "description": "Open SUPERIR requirement with the earliest verified due date.", "properties": { "action": { "description": "Next action, or the instruction when none.", "type": "string" }, "dueDate": { "description": "Only a verified due date.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "state": { "description": "Stored state (PENDIENTE, PARCIAL, OBSERVADO, POR_VERIFICAR).", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "action", "state", "dueDate" ], "type": [ "object", "null" ] }, "nextStep": { "properties": { "action": { "type": "string" }, "actor": { "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "phase": { "type": "string" }, "plazo": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "ruleKey", "title", "phase", "action" ], "type": [ "object", "null" ] }, "nextTask": { "description": "Open report task with the earliest due date.", "properties": { "action": { "description": "Task description.", "type": [ "string", "null" ] }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "action", "dueDate" ], "type": [ "object", "null" ] }, "openTasks": { "type": "integer" }, "overdueCount": { "type": "integer" }, "pendingInstructions": { "description": "Open SUPERIR requirements.", "type": "integer" }, "plazos": { "items": { "properties": { "approx": { "type": "boolean" }, "baseDate": { "format": "date-time", "type": "string" }, "baseEvent": { "type": "string" }, "businessDays": { "description": "Business is kept for the web's existing shape: true for any non-calendar rule.", "type": "boolean" }, "dayRule": { "type": "string" }, "dayRuleLabel": { "type": "string" }, "days": { "description": "Number of days.", "type": "integer" }, "daysLeft": { "type": "integer" }, "doneDate": { "format": "date-time", "type": [ "string", "null" ] }, "doneEvent": { "type": "string" }, "dueDate": { "description": "Due date (ISO 8601).", "format": "date-time", "type": "string" }, "key": { "description": "Stable key.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "note": { "description": "Free-text note.", "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "key", "title", "legalBasis", "note", "baseEvent", "baseDate", "dueDate", "days", "businessDays", "dayRule", "dayRuleLabel", "approx", "status", "daysLeft" ], "type": "object" }, "type": "array" }, "reportVerdict": { "description": "Verdict as the portfolio reports compute it.", "enum": [ "BLOQUEADA", "NO_CONCLUYENTE", "HABILITADA", "SIN_ANALISIS" ], "type": "string" }, "rolYear": { "description": "Year read from the rol.", "type": [ "integer", "null" ] } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidacion cierre", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidacion-document-url": { "post": { "description": "Signed URL for a liquidación document.\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidacion-document-url", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "path": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "path": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "previewUrl": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "previewUrl": { "description": "Short-lived URL to preview the file.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidacion document url", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidations-canonical-causes": { "post": { "description": "Get liquidaciones canonical causas\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidations-canonical-causes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "assignedToMe": false, "estado": "", "page": 0, "per_page": 0, "region": "", "search": "", "sort": "", "tipoProc": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "assignedToMe": { "type": "boolean" }, "estado": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "region": { "type": "string" }, "search": { "type": "string" }, "sort": { "type": "string" }, "tipoProc": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "id": "string", "source": "L", "documentId": "string", "rol": "string", "nombre": "string", "estado": "string", "deudorRut": "string", "tribunal": "string", "liquidador": "string", "tipoProcedimiento": "string", "region": "string", "ultimaGestion": "string", "fechaUltimaGestion": "string", "fecha": "string", "causaId": "string", "createdAt": "string", "updatedAt": "string", "causaRol": "string", "groupId": "string", "preferredSource": "string", "sources": [ "string" ], "primaryCausaIds": [ "string" ], "sourceRecordIds": [ "string" ], "relatedCausas": [ { "id": "string", "relationType": "string", "causaId": "string", "rol": "string", "caratulado": "string", "tribunal": "string", "competence": "string", "corteId": 0, "tribunalId": 0, "identityKey": "string" } ], "assignedUserIds": [ "string" ], "assignees": [ { "userId": "string", "name": "string", "email": "string" } ] } ], "pageCount": 0, "total": 0, "estados": [ "string" ], "regiones": [ "string" ], "tiposProcedimiento": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causas": { "description": "One entry per canonical procedimiento (records merged across sources).", "items": { "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "assignees": { "items": { "properties": { "email": { "description": "Email address.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "email" ], "type": "object" }, "type": "array" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "causaRol": { "type": [ "string", "null" ] }, "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "deudorRut": { "description": "Debtor's RUT.", "type": [ "string", "null" ] }, "documentId": { "description": "Document id.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "fechaUltimaGestion": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "groupId": { "type": "string" }, "id": { "description": "Preferred record id (the liquidador record when there is one).", "type": "string" }, "liquidador": { "type": [ "string", "null" ] }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "preferredSource": { "type": "string" }, "primaryCausaIds": { "items": { "type": "string" }, "type": "array" }, "region": { "description": "Chilean region.", "type": [ "string", "null" ] }, "relatedCausas": { "description": "Causas related to this one (exhortos, appeals).", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": [ "string", "null" ] }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "identityKey": { "type": "string" }, "relationType": { "description": "How the causas are related.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "relationType", "causaId", "rol", "caratulado", "tribunal", "competence", "corteId", "tribunalId", "identityKey" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "enum": [ "L", "P" ], "type": "string" }, "sourceRecordIds": { "items": { "type": "string" }, "type": "array" }, "sources": { "items": { "type": "string" }, "type": "array" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "ultimaGestion": { "description": "Last collection action (ISO 8601).", "type": [ "string", "null" ] }, "updatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" } }, "required": [ "id", "source", "documentId", "rol", "nombre", "estado", "deudorRut", "tribunal", "liquidador", "tipoProcedimiento", "region", "ultimaGestion", "fechaUltimaGestion", "fecha", "causaId", "createdAt", "updatedAt", "causaRol", "groupId", "preferredSource", "sources", "primaryCausaIds", "sourceRecordIds", "relatedCausas", "assignedUserIds", "assignees" ], "type": "object" }, "type": "array" }, "estados": { "description": "Available status values.", "items": { "type": "string" }, "type": "array" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "regiones": { "description": "Chilean regions.", "items": { "type": "string" }, "type": "array" }, "tiposProcedimiento": { "description": "Procedure types.", "items": { "type": "string" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "causas", "pageCount", "total", "estados", "regiones", "tiposProcedimiento" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidaciones canonical causas", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidations-liquidador-cause": { "post": { "description": "One liquidador causa.\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidations-liquidador-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "publications": [ { "id": "string", "nombre": "string", "fecha": "2026-01-31T12:00:00Z", "estado": "string", "entePublicador": "string", "documentoUrl": "string", "documentoStoragePath": "string", "documentoSha256": "string", "documentoBytes": 0, "documentoMime": "string", "documentoDownloadedAt": "2026-01-31T12:00:00Z", "raw": null, "createdAt": "2026-01-31T12:00:00Z", "note": { "id": "string", "text": "string", "updatedAt": "2026-01-31T12:00:00Z" } } ], "stages": [ { "id": "string", "nombre": "string", "fechaEstimada": "2026-01-31T12:00:00Z", "estado": "string", "raw": null, "note": { "id": "string", "text": "string", "updatedAt": "2026-01-31T12:00:00Z" } } ], "actions": [ { "id": "string", "numero": "string", "materia": "string", "fecha": "2026-01-31T12:00:00Z", "estado": "string", "documentoUrl": "string", "documentoStoragePath": "string", "documentoSha256": "string", "documentoBytes": 0, "documentoMime": "string", "documentoDownloadedAt": "2026-01-31T12:00:00Z", "raw": null, "note": { "id": "string", "text": "string", "updatedAt": "2026-01-31T12:00:00Z" } } ], "notes": [ { "id": "string", "text": "string", "itemDesc": "string", "orgId": "string", "modifiedById": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "relatedCausas": [ { "id": "string", "relationType": "string", "note": "string", "causaId": "string", "rol": "string", "caratulado": "string", "tribunal": "string", "competence": "string", "corteId": 0, "tribunalId": 0, "createdAt": "2026-01-31T12:00:00Z" } ], "bitacoras": [ { "id": "string", "title": "string", "content": "string", "orgId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "bitacoraScope": "string", "source": "string", "findings": [ { "id": "string", "ruleKey": "string", "title": "string", "state": "string", "severity": "string", "explanation": "string", "reviewedState": "string", "taskId": "string", "reviewNote": "string", "reviewedAt": "2026-01-31T12:00:00Z", "evidence": { "source": "L", "items": [ "string" ], "references": [ { "id": "string", "source": "publications", "title": "string", "date": "string", "evidenceCandidate": true } ] } } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "actions": { "items": { "properties": { "documentoBytes": { "description": "Size of the downloaded document in bytes.", "type": [ "integer", "null" ] }, "documentoDownloadedAt": { "description": "When the document was downloaded (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "documentoMime": { "description": "MIME type of the downloaded document.", "type": [ "string", "null" ] }, "documentoSha256": { "description": "SHA-256 of the downloaded document.", "type": [ "string", "null" ] }, "documentoStoragePath": { "description": "Handle of Nexulex's stored copy: pass it with the causa id to get-liquidacion-document-url for a download link (checked against your organization).", "type": [ "string", "null" ] }, "documentoUrl": { "description": "Short-lived URL of the downloaded document.", "type": [ "string", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "materia": { "description": "Subject matter.", "type": "string" }, "note": { "description": "Free-text note.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "updatedAt" ], "type": [ "object", "null" ] }, "numero": { "description": "Number.", "type": [ "string", "null" ] }, "raw": { "description": "Unparsed value as received from the source.", "type": "null" } }, "required": [ "id", "numero", "materia", "fecha", "estado", "documentoUrl", "documentoStoragePath", "documentoSha256", "documentoBytes", "documentoMime", "documentoDownloadedAt", "raw", "note" ], "type": "object" }, "type": "array" }, "bitacoraScope": { "type": "string" }, "bitacoras": { "items": { "properties": { "content": { "description": "Content.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "content", "orgId", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "findings": { "items": { "properties": { "evidence": { "description": "Supporting evidence.", "properties": { "items": { "description": "The records returned.", "items": { "type": "string" }, "type": "array" }, "references": { "description": "References.", "items": { "properties": { "date": { "description": "Publication or action date as stored (timestamp string).", "type": [ "string", "null" ] }, "evidenceCandidate": { "description": "The movement reads as evidence for the rule.", "type": "boolean" }, "id": { "description": "Publication or action id.", "type": "string" }, "source": { "description": "Where the record came from.", "enum": [ "publications", "actions" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "title", "date", "evidenceCandidate" ], "type": "object" }, "type": "array" }, "source": { "description": "Source of the procedimiento the finding was evaluated on.", "enum": [ "L", "P" ], "type": "string" } }, "required": [ "source", "items", "references" ], "type": "object" }, "explanation": { "description": "Explanation.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "reviewNote": { "type": "string" }, "reviewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "reviewedState": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "severity": { "description": "Severity.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "ruleKey", "title", "state", "severity", "explanation", "reviewedState", "taskId", "reviewNote", "reviewedAt", "evidence" ], "type": "object" }, "type": [ "array", "null" ] }, "notes": { "description": "Free-text notes.", "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "itemDesc": { "type": "string" }, "modifiedById": { "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "itemDesc", "orgId", "modifiedById", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "publications": { "description": "Publications.", "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "documentoBytes": { "description": "Size of the downloaded document in bytes.", "type": [ "integer", "null" ] }, "documentoDownloadedAt": { "description": "When the document was downloaded (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "documentoMime": { "description": "MIME type of the downloaded document.", "type": [ "string", "null" ] }, "documentoSha256": { "description": "SHA-256 of the downloaded document.", "type": [ "string", "null" ] }, "documentoStoragePath": { "description": "Handle of Nexulex's stored copy: pass it with the causa id to get-liquidacion-document-url for a download link (checked against your organization).", "type": [ "string", "null" ] }, "documentoUrl": { "description": "Short-lived URL of the downloaded document.", "type": [ "string", "null" ] }, "entePublicador": { "type": [ "string", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "note": { "description": "Free-text note.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "updatedAt" ], "type": [ "object", "null" ] }, "raw": { "description": "Unparsed value as received from the source.", "type": "null" } }, "required": [ "id", "nombre", "fecha", "estado", "entePublicador", "documentoUrl", "documentoStoragePath", "documentoSha256", "documentoBytes", "documentoMime", "documentoDownloadedAt", "raw", "createdAt", "note" ], "type": "object" }, "type": "array" }, "relatedCausas": { "description": "Causas related to this one (exhortos, appeals).", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": [ "string", "null" ] }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "note": { "description": "Free-text note.", "type": [ "string", "null" ] }, "relationType": { "description": "How the causas are related.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "relationType", "note", "causaId", "rol", "caratulado", "tribunal", "competence", "corteId", "tribunalId", "createdAt" ], "type": "object" }, "type": "array" }, "source": { "description": "Where the record came from.", "type": "string" }, "stages": { "description": "Stages.", "items": { "properties": { "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fechaEstimada": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "note": { "description": "Free-text note.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "updatedAt" ], "type": [ "object", "null" ] }, "raw": { "description": "Unparsed value as received from the source.", "type": "null" } }, "required": [ "id", "nombre", "fechaEstimada", "estado", "raw", "note" ], "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidaciones liquidador causa", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidations-liquidador-causes": { "post": { "description": "List liquidador causas (Boletín Concursal).\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidations-liquidador-causes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "assignedToMe": false, "estado": "", "page": 0, "per_page": 0, "region": "", "search": "", "sort": "", "tipoProc": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "assignedToMe": { "type": "boolean" }, "estado": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "region": { "type": "string" }, "search": { "type": "string" }, "sort": { "type": "string" }, "tipoProc": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "id": "string", "documentId": "string", "rol": "string", "nombre": "string", "estado": "string", "deudorRut": "string", "tribunal": "string", "liquidador": "string", "tipoProcedimiento": "string", "region": "string", "rolSujeto": "string", "sujetoTitular": "string", "veedorAsociado": "string", "tieneMartilleros": true, "liquidadorAsociado": true, "glosas": null, "ultimaGestion": "string", "fechaUltimaGestion": "2026-01-31T12:00:00Z", "cantidadGestiones": 0, "fecha": "2026-01-31T12:00:00Z", "causaId": "string", "causaRol": "string", "relatedCausas": [ { "id": "string", "relationType": "string", "causaId": "string", "rol": "string" } ], "assignedUserIds": [ "string" ], "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "pageCount": 0, "total": 0, "estados": [ "string" ], "regiones": [ "string" ], "tiposProcedimiento": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causas": { "description": "PJUD causas.", "items": { "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "cantidadGestiones": { "description": "Number of collection actions.", "type": [ "integer", "null" ] }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "causaRol": { "description": "En Laboral, Penal, Cobranza es RIT", "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "deudorRut": { "description": "Debtor's RUT.", "type": [ "string", "null" ] }, "documentId": { "description": "Document id.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaUltimaGestion": { "format": "date-time", "type": [ "string", "null" ] }, "glosas": { "type": "null" }, "id": { "description": "Unique identifier.", "type": "string" }, "liquidador": { "type": [ "string", "null" ] }, "liquidadorAsociado": { "type": "boolean" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "region": { "description": "Chilean region.", "type": [ "string", "null" ] }, "relatedCausas": { "description": "Causas related to this one (exhortos, appeals).", "items": { "properties": { "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "relationType": { "description": "How the causas are related.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "id", "relationType", "causaId", "rol" ], "type": "object" }, "type": [ "array", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "rolSujeto": { "type": [ "string", "null" ] }, "sujetoTitular": { "type": [ "string", "null" ] }, "tieneMartilleros": { "type": "boolean" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "ultimaGestion": { "description": "Last collection action (ISO 8601).", "type": [ "string", "null" ] }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "veedorAsociado": { "type": [ "string", "null" ] } }, "required": [ "id", "documentId", "rol", "nombre", "estado", "deudorRut", "tribunal", "liquidador", "tipoProcedimiento", "region", "rolSujeto", "sujetoTitular", "veedorAsociado", "tieneMartilleros", "liquidadorAsociado", "glosas", "ultimaGestion", "fechaUltimaGestion", "cantidadGestiones", "fecha", "causaId", "causaRol", "relatedCausas", "assignedUserIds", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "estados": { "description": "Available status values.", "items": { "type": "string" }, "type": "array" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "regiones": { "description": "Chilean regions.", "items": { "type": "string" }, "type": "array" }, "tiposProcedimiento": { "description": "Procedure types.", "items": { "type": "string" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "causas", "pageCount", "total", "estados", "regiones", "tiposProcedimiento" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidaciones liquidador causas", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidations-prioridad": { "post": { "description": "Priority report (oldest first).\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidations-prioridad", "requestBody": { "content": { "application/json": { "example": { "args": [ { "actionCategory": "", "assignedToMe": false, "drilldown": "", "estado": "", "hito": "", "page": 0, "per_page": 0, "portfolioReview": false, "region": "", "search": "", "sort": "", "source": "", "tipoProc": "", "verdict": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "actionCategory": { "type": "string" }, "assignedToMe": { "type": "boolean" }, "drilldown": { "type": "string" }, "estado": { "type": "string" }, "hito": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "portfolioReview": { "type": "boolean" }, "region": { "type": "string" }, "search": { "type": "string" }, "sort": { "type": "string" }, "source": { "type": "string" }, "tipoProc": { "type": "string" }, "verdict": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "id": "string", "source": "L", "documentId": "string", "rol": "string", "nombre": "string", "estado": "string", "tipoProcedimiento": "string", "region": "string", "tribunal": "string", "liquidador": "string", "deudorRut": "string", "fecha": "string", "ultimaPublicacionRelevante": "string", "cantidadGestiones": 0, "publicationsCaptured": 0, "verdict": "BLOQUEADA", "blockers": 0, "pendingTotal": 0, "pendingHigh": 0, "pendingMedium": 0, "pendingKeys": [ "string" ], "blockerKeys": [ "string" ], "blockerTitles": [ "string" ], "asignada": true, "stagesOverdue": 0, "assignedUserIds": [ "string" ], "assignees": [ { "userId": "string", "name": "string", "email": "string" } ], "causaId": "string", "causaRol": "string", "findingsCount": 0, "analysisUpdatedAt": "string", "actionCategory": "RESPONDER_SUPERIR", "familia": "empresa", "nextStep": { "ruleKey": "string", "title": "string", "phase": "string", "legalBasis": "string", "plazo": "string", "action": "string", "actor": "string" }, "priorityReason": "string", "motivos": [ "string" ], "rolYear": 0, "ageDays": 0, "ageApprox": true, "idleDays": 0, "fechaUltimaGestion": "string", "lastSubstantiveAt": "string", "idleSource": "documented_review", "legalStatus": "TERMINO_FIRME", "adminStatus": "CERRADO", "pendingInstructions": 0, "overdueCount": 0, "dueSoonCount": 0, "nextDueDate": "string", "nextRequirement": { "id": "string", "title": "string", "action": "string", "state": "string", "dueDate": "string" }, "nextTask": { "id": "string", "title": "string", "action": "string", "dueDate": "string" }, "openTasks": 0 } ], "total": 0, "page": 0, "perPage": 0, "pageCount": 0, "sort": "string", "estado": "string", "verdictCounts": { "\u003ckey\u003e": 0 }, "hito": "string", "hitoTitle": "string", "analysisUpdatedAt": "string", "estados": [ "string" ], "tiposProcedimiento": [ "string" ], "regiones": [ "string" ], "verdictOrder": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "analysisUpdatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "causas": { "description": "PJUD causas.", "items": { "properties": { "actionCategory": { "enum": [ "RESPONDER_SUPERIR", "COMPLETAR_CIERRE_ADMINISTRATIVO", "ACREDITAR_EJECUTORIA", "REVISAR_REQUISITOS_DE_TERMINO", "AVANZAR_TRAMITACION" ], "type": "string" }, "adminStatus": { "enum": [ "CERRADO", "INSTRUCCIONES_PENDIENTES", "POR_REVISAR" ], "type": "string" }, "ageApprox": { "description": "ageDays is estimated from the rol year.", "type": "boolean" }, "ageDays": { "description": "Days since the procedimiento started (fecha, or 1 January of the rol year).", "type": [ "integer", "null" ] }, "analysisUpdatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "asignada": { "description": "Assigned to a member of this organization.", "type": "boolean" }, "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "assignees": { "items": { "properties": { "email": { "description": "Email address.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "email" ], "type": "object" }, "type": "array" }, "blockerKeys": { "items": { "type": "string" }, "type": "array" }, "blockerTitles": { "items": { "type": "string" }, "type": "array" }, "blockers": { "type": "integer" }, "cantidadGestiones": { "description": "Number of collection actions.", "type": [ "integer", "null" ] }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "causaRol": { "type": [ "string", "null" ] }, "deudorRut": { "description": "Debtor's RUT.", "type": [ "string", "null" ] }, "documentId": { "description": "Document id.", "type": "string" }, "dueSoonCount": { "description": "Due within seven days.", "type": "integer" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "familia": { "enum": [ "empresa", "persona", "simplificada", "derivada", "desconocida" ], "type": "string" }, "fecha": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "fechaUltimaGestion": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "findingsCount": { "type": "integer" }, "id": { "description": "Unique identifier.", "type": "string" }, "idleDays": { "description": "Days since the last substantive gestión.", "type": [ "integer", "null" ] }, "idleSource": { "enum": [ "documented_review", "communication", "publication" ], "type": [ "string", "null" ] }, "lastSubstantiveAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "legalStatus": { "enum": [ "TERMINO_FIRME", "TERMINO_PUBLICADO", "CUENTA_APROBADA", "EN_TRAMITACION" ], "type": "string" }, "liquidador": { "type": [ "string", "null" ] }, "motivos": { "description": "Why the row sits where it does, in the page's words.", "items": { "type": "string" }, "type": "array" }, "nextDueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "nextRequirement": { "description": "Open SUPERIR requirement with the earliest verified due date.", "properties": { "action": { "description": "Next action, or the instruction when none.", "type": "string" }, "dueDate": { "description": "Only a verified due date.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "state": { "description": "Stored state (PENDIENTE, PARCIAL, OBSERVADO, POR_VERIFICAR).", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "action", "state", "dueDate" ], "type": [ "object", "null" ] }, "nextStep": { "properties": { "action": { "type": [ "string", "null" ] }, "actor": { "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "phase": { "type": "string" }, "plazo": { "type": "string" }, "ruleKey": { "description": "Rule key of the hito, a synthetic key (tarea-pendiente, comunicacion-directa, conciliacion-bienes) or empty.", "type": "string" }, "title": { "description": "Title.", "type": [ "string", "null" ] } }, "required": [ "ruleKey", "title", "phase", "action" ], "type": "object" }, "nextTask": { "description": "Open report task with the earliest due date.", "properties": { "action": { "description": "Task description.", "type": [ "string", "null" ] }, "dueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "action", "dueDate" ], "type": [ "object", "null" ] }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "openTasks": { "type": "integer" }, "overdueCount": { "type": "integer" }, "pendingHigh": { "type": "integer" }, "pendingInstructions": { "description": "Open SUPERIR requirements.", "type": "integer" }, "pendingKeys": { "items": { "type": "string" }, "type": "array" }, "pendingMedium": { "type": "integer" }, "pendingTotal": { "type": "integer" }, "priorityReason": { "type": "string" }, "publicationsCaptured": { "type": "integer" }, "region": { "description": "Chilean region.", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "rolYear": { "description": "Year read from the rol.", "type": [ "integer", "null" ] }, "source": { "description": "Where the record came from.", "enum": [ "L", "P" ], "type": "string" }, "stagesOverdue": { "description": "Portal stages past their estimated date.", "type": "integer" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "ultimaPublicacionRelevante": { "type": [ "string", "null" ] }, "verdict": { "enum": [ "BLOQUEADA", "NO_CONCLUYENTE", "HABILITADA", "SIN_ANALISIS" ], "type": "string" } }, "required": [ "id", "source", "documentId", "rol", "nombre", "estado", "tipoProcedimiento", "region", "tribunal", "liquidador", "deudorRut", "fecha", "ultimaPublicacionRelevante", "cantidadGestiones", "publicationsCaptured", "verdict", "blockers", "pendingTotal", "pendingHigh", "pendingMedium", "pendingKeys", "blockerKeys", "blockerTitles", "asignada", "stagesOverdue", "assignedUserIds", "assignees", "causaId", "causaRol", "findingsCount", "analysisUpdatedAt", "actionCategory", "familia", "nextStep", "priorityReason", "motivos", "rolYear", "ageDays", "ageApprox", "idleDays", "fechaUltimaGestion", "lastSubstantiveAt", "idleSource", "legalStatus", "adminStatus", "pendingInstructions", "overdueCount", "dueSoonCount", "nextDueDate", "nextRequirement", "nextTask", "openTasks" ], "type": "object" }, "type": "array" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "estados": { "description": "Available status values.", "items": { "type": "string" }, "type": "array" }, "hito": { "type": "string" }, "hitoTitle": { "type": "string" }, "page": { "description": "Current page number (1-based).", "type": "integer" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "perPage": { "description": "Page size.", "type": "integer" }, "regiones": { "description": "Chilean regions.", "items": { "type": "string" }, "type": "array" }, "sort": { "type": "string" }, "tiposProcedimiento": { "description": "Procedure types.", "items": { "type": "string" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" }, "verdictCounts": { "additionalProperties": { "type": "integer" }, "description": "Procedimientos per verdict (BLOQUEADA, NO_CONCLUYENTE, HABILITADA, SIN_ANALISIS).", "type": "object" }, "verdictOrder": { "items": { "type": "string" }, "type": "array" } }, "required": [ "causas", "total", "page", "perPage", "pageCount", "sort", "estado", "verdictCounts", "hito", "hitoTitle", "analysisUpdatedAt", "estados", "tiposProcedimiento", "regiones", "verdictOrder" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidaciones prioridad", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidations-public-cause": { "post": { "description": "One public Boletín Concursal causa.\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidations-public-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "publications": [ { "id": "string", "nombre": "string", "fecha": "2026-01-31T12:00:00Z", "estado": "string", "entePublicador": "string", "documentoUrl": "string", "documentoStoragePath": "string", "documentoSha256": "string", "documentoBytes": 0, "documentoMime": "string", "documentoDownloadedAt": "2026-01-31T12:00:00Z", "raw": null, "createdAt": "2026-01-31T12:00:00Z", "note": { "id": "string", "text": "string", "updatedAt": "2026-01-31T12:00:00Z" } } ], "stages": [ { "id": "string", "nombre": "string", "fechaEstimada": "2026-01-31T12:00:00Z", "estado": "string", "raw": null, "note": { "id": "string", "text": "string", "updatedAt": "2026-01-31T12:00:00Z" } } ], "actions": [ { "id": "string", "numero": "string", "materia": "string", "fecha": "2026-01-31T12:00:00Z", "estado": "string", "documentoUrl": "string", "documentoStoragePath": "string", "documentoSha256": "string", "documentoBytes": 0, "documentoMime": "string", "documentoDownloadedAt": "2026-01-31T12:00:00Z", "raw": null, "note": { "id": "string", "text": "string", "updatedAt": "2026-01-31T12:00:00Z" } } ], "notes": [ { "id": "string", "text": "string", "itemDesc": "string", "orgId": "string", "modifiedById": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "relatedCausas": [ { "id": "string", "relationType": "string", "note": "string", "causaId": "string", "rol": "string", "caratulado": "string", "tribunal": "string", "competence": "string", "corteId": 0, "tribunalId": 0, "createdAt": "2026-01-31T12:00:00Z" } ], "bitacoras": [ { "id": "string", "title": "string", "content": "string", "orgId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "bitacoraScope": "string", "source": "string", "findings": [ { "id": "string", "ruleKey": "string", "title": "string", "state": "string", "severity": "string", "explanation": "string", "reviewedState": "string", "taskId": "string", "reviewNote": "string", "reviewedAt": "2026-01-31T12:00:00Z", "evidence": { "source": "L", "items": [ "string" ], "references": [ { "id": "string", "source": "publications", "title": "string", "date": "string", "evidenceCandidate": true } ] } } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "actions": { "items": { "properties": { "documentoBytes": { "description": "Size of the downloaded document in bytes.", "type": [ "integer", "null" ] }, "documentoDownloadedAt": { "description": "When the document was downloaded (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "documentoMime": { "description": "MIME type of the downloaded document.", "type": [ "string", "null" ] }, "documentoSha256": { "description": "SHA-256 of the downloaded document.", "type": [ "string", "null" ] }, "documentoStoragePath": { "description": "Handle of Nexulex's stored copy: pass it with the causa id to get-liquidacion-document-url for a download link (checked against your organization).", "type": [ "string", "null" ] }, "documentoUrl": { "description": "Short-lived URL of the downloaded document.", "type": [ "string", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "materia": { "description": "Subject matter.", "type": "string" }, "note": { "description": "Free-text note.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "updatedAt" ], "type": [ "object", "null" ] }, "numero": { "description": "Number.", "type": [ "string", "null" ] }, "raw": { "description": "Unparsed value as received from the source.", "type": "null" } }, "required": [ "id", "numero", "materia", "fecha", "estado", "documentoUrl", "documentoStoragePath", "documentoSha256", "documentoBytes", "documentoMime", "documentoDownloadedAt", "raw", "note" ], "type": "object" }, "type": "array" }, "bitacoraScope": { "type": "string" }, "bitacoras": { "items": { "properties": { "content": { "description": "Content.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "title": { "description": "Title.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "content", "orgId", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "findings": { "items": { "properties": { "evidence": { "description": "Supporting evidence.", "properties": { "items": { "description": "The records returned.", "items": { "type": "string" }, "type": "array" }, "references": { "description": "References.", "items": { "properties": { "date": { "description": "Publication or action date as stored (timestamp string).", "type": [ "string", "null" ] }, "evidenceCandidate": { "description": "The movement reads as evidence for the rule.", "type": "boolean" }, "id": { "description": "Publication or action id.", "type": "string" }, "source": { "description": "Where the record came from.", "enum": [ "publications", "actions" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "title", "date", "evidenceCandidate" ], "type": "object" }, "type": "array" }, "source": { "description": "Source of the procedimiento the finding was evaluated on.", "enum": [ "L", "P" ], "type": "string" } }, "required": [ "source", "items", "references" ], "type": "object" }, "explanation": { "description": "Explanation.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "reviewNote": { "type": "string" }, "reviewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "reviewedState": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "severity": { "description": "Severity.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "ruleKey", "title", "state", "severity", "explanation", "reviewedState", "taskId", "reviewNote", "reviewedAt", "evidence" ], "type": "object" }, "type": [ "array", "null" ] }, "notes": { "description": "Free-text notes.", "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "itemDesc": { "type": "string" }, "modifiedById": { "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "itemDesc", "orgId", "modifiedById", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "publications": { "description": "Publications.", "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "documentoBytes": { "description": "Size of the downloaded document in bytes.", "type": [ "integer", "null" ] }, "documentoDownloadedAt": { "description": "When the document was downloaded (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "documentoMime": { "description": "MIME type of the downloaded document.", "type": [ "string", "null" ] }, "documentoSha256": { "description": "SHA-256 of the downloaded document.", "type": [ "string", "null" ] }, "documentoStoragePath": { "description": "Handle of Nexulex's stored copy: pass it with the causa id to get-liquidacion-document-url for a download link (checked against your organization).", "type": [ "string", "null" ] }, "documentoUrl": { "description": "Short-lived URL of the downloaded document.", "type": [ "string", "null" ] }, "entePublicador": { "type": [ "string", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "note": { "description": "Free-text note.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "updatedAt" ], "type": [ "object", "null" ] }, "raw": { "description": "Unparsed value as received from the source.", "type": "null" } }, "required": [ "id", "nombre", "fecha", "estado", "entePublicador", "documentoUrl", "documentoStoragePath", "documentoSha256", "documentoBytes", "documentoMime", "documentoDownloadedAt", "raw", "createdAt", "note" ], "type": "object" }, "type": "array" }, "relatedCausas": { "description": "Causas related to this one (exhortos, appeals).", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": [ "string", "null" ] }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "note": { "description": "Free-text note.", "type": [ "string", "null" ] }, "relationType": { "description": "How the causas are related.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "relationType", "note", "causaId", "rol", "caratulado", "tribunal", "competence", "corteId", "tribunalId", "createdAt" ], "type": "object" }, "type": "array" }, "source": { "description": "Where the record came from.", "type": "string" }, "stages": { "description": "Stages.", "items": { "properties": { "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fechaEstimada": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "note": { "description": "Free-text note.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "text": { "description": "Text content.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "text", "updatedAt" ], "type": [ "object", "null" ] }, "raw": { "description": "Unparsed value as received from the source.", "type": "null" } }, "required": [ "id", "nombre", "fechaEstimada", "estado", "raw", "note" ], "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidaciones public causa", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidations-public-causes": { "post": { "description": "List public Boletín Concursal causas followed by the organization.\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidations-public-causes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "assignedToMe": false, "estado": "", "page": 0, "per_page": 0, "region": "", "search": "", "sort": "", "tipoProc": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "assignedToMe": { "type": "boolean" }, "estado": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "region": { "type": "string" }, "search": { "type": "string" }, "sort": { "type": "string" }, "tipoProc": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "id": "string", "documentId": "string", "rol": "string", "nombre": "string", "estado": "string", "deudorRut": "string", "tribunal": "string", "liquidador": "string", "tipoProcedimiento": "string", "region": "string", "rolSujeto": "string", "sujetoTitular": "string", "veedorAsociado": "string", "tieneMartilleros": true, "liquidadorAsociado": true, "glosas": null, "ultimaGestion": "string", "fechaUltimaGestion": "2026-01-31T12:00:00Z", "cantidadGestiones": 0, "fecha": "2026-01-31T12:00:00Z", "causaId": "string", "causaRol": "string", "relatedCausas": [ { "id": "string", "relationType": "string", "causaId": "string", "rol": "string" } ], "assignedUserIds": [ "string" ], "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "pageCount": 0, "total": 0, "estados": [ "string" ], "regiones": [ "string" ], "tiposProcedimiento": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causas": { "description": "PJUD causas.", "items": { "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "cantidadGestiones": { "description": "Number of collection actions.", "type": [ "integer", "null" ] }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "causaRol": { "description": "En Laboral, Penal, Cobranza es RIT", "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "deudorRut": { "description": "Debtor's RUT.", "type": [ "string", "null" ] }, "documentId": { "description": "Document id.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaUltimaGestion": { "format": "date-time", "type": [ "string", "null" ] }, "glosas": { "type": "null" }, "id": { "description": "Unique identifier.", "type": "string" }, "liquidador": { "type": [ "string", "null" ] }, "liquidadorAsociado": { "type": "boolean" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "region": { "description": "Chilean region.", "type": [ "string", "null" ] }, "relatedCausas": { "description": "Causas related to this one (exhortos, appeals).", "items": { "properties": { "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "relationType": { "description": "How the causas are related.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "id", "relationType", "causaId", "rol" ], "type": "object" }, "type": [ "array", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "rolSujeto": { "type": [ "string", "null" ] }, "sujetoTitular": { "type": [ "string", "null" ] }, "tieneMartilleros": { "type": "boolean" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "ultimaGestion": { "description": "Last collection action (ISO 8601).", "type": [ "string", "null" ] }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "veedorAsociado": { "type": [ "string", "null" ] } }, "required": [ "id", "documentId", "rol", "nombre", "estado", "deudorRut", "tribunal", "liquidador", "tipoProcedimiento", "region", "rolSujeto", "sujetoTitular", "veedorAsociado", "tieneMartilleros", "liquidadorAsociado", "glosas", "ultimaGestion", "fechaUltimaGestion", "cantidadGestiones", "fecha", "causaId", "causaRol", "relatedCausas", "assignedUserIds", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "estados": { "description": "Available status values.", "items": { "type": "string" }, "type": "array" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "regiones": { "description": "Chilean regions.", "items": { "type": "string" }, "type": "array" }, "tiposProcedimiento": { "description": "Procedure types.", "items": { "type": "string" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "causas", "pageCount", "total", "estados", "regiones", "tiposProcedimiento" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidaciones public causas", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidations-reporte-general": { "post": { "description": "General liquidaciones report.\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidations-reporte-general", "requestBody": { "content": { "application/json": { "example": { "args": [ { "actionCategory": "", "assignedToMe": false, "drilldown": "", "estado": "", "hito": "", "page": 0, "per_page": 0, "portfolioReview": false, "region": "", "search": "", "sort": "", "source": "", "tipoProc": "", "verdict": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "actionCategory": { "type": "string" }, "assignedToMe": { "type": "boolean" }, "drilldown": { "type": "string" }, "estado": { "type": "string" }, "hito": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "portfolioReview": { "type": "boolean" }, "region": { "type": "string" }, "search": { "type": "string" }, "sort": { "type": "string" }, "source": { "type": "string" }, "tipoProc": { "type": "string" }, "verdict": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "total": 0, "vigentes": 0, "terminadas": 0, "otras": 0, "bySource": [ { "label": "string", "count": 0 } ], "byEstado": [ { "label": "string", "count": 0 } ], "byTipo": [ { "label": "string", "count": 0 } ], "byTipoOtros": 0, "byFamilia": [ { "label": "string", "count": 0 } ], "byRegion": [ { "label": "string", "count": 0 } ], "byRegionOtros": 0, "byTribunal": [ { "label": "string", "count": 0 } ], "byTribunalOtros": 0, "byLiquidador": [ { "label": "string", "count": 0 } ], "byLiquidadorOtros": 0, "byRolYear": [ { "label": "string", "count": 0 } ], "ageBuckets": { "order": [ "string" ], "counts": { "\u003ckey\u003e": 0 } }, "idleBuckets": { "order": [ "string" ], "counts": { "\u003ckey\u003e": 0 } }, "verdictOrder": [ "string" ], "verdictCounts": { "\u003ckey\u003e": 0 }, "pendingByRule": [ { "label": "string", "count": 0, "ruleKey": "string", "title": "string", "phase": "string", "order": 0, "closingRole": "string" } ], "blockersByRule": [ { "label": "string", "count": 0, "ruleKey": "string", "title": "string", "phase": "string", "order": 0, "closingRole": "string" } ], "vigentesSinPublicaciones": 0, "vigentesSinAnalisis": 0, "vigentesAsignadas": 0, "vigentesSinAsignar": 0, "vigentesSinGestion90": 0, "vigentesSinGestion180": 0, "vigentesMas5Anios": 0, "vigentesEtapasVencidas": 0, "vigentesCasiCerradas": 0, "vencimientosVencidos": 0, "vencimientosProximos": 0, "instruccionesPendientes": 0, "cierresAdministrativosPendientes": 0, "byActionCategory": [ { "label": "string", "count": 0 } ], "ageStats": { "avgDays": 0, "medianDays": 0, "maxDays": 0 }, "oldest": [ { "id": "string", "source": "string", "rol": "string", "nombre": "string", "estado": "string", "tipoProcedimiento": "string", "tribunal": "string", "fecha": "string", "rolYear": 0, "ageDays": 0, "ageApprox": true, "idleDays": 0, "verdict": "string", "blockers": 0, "pendingTotal": 0, "publicationsCaptured": 0, "familia": "string" } ], "openTasks": 0, "analysisUpdatedAt": "string", "estados": [ "string" ], "tiposProcedimiento": [ "string" ], "regiones": [ "string" ], "byClosingWork": [ { "key": "string", "label": "string", "count": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ageBuckets": { "properties": { "counts": { "additionalProperties": { "type": "integer" }, "description": "Vigente procedimientos per age bucket (keys in ageBuckets.order).", "type": "object" }, "order": { "description": "Sort position.", "items": { "type": "string" }, "type": "array" } }, "required": [ "order", "counts" ], "type": "object" }, "ageStats": { "description": "Age of vigente procedimientos, in days.", "properties": { "avgDays": { "type": [ "integer", "null" ] }, "maxDays": { "type": [ "integer", "null" ] }, "medianDays": { "type": [ "number", "null" ] } }, "required": [ "avgDays", "medianDays", "maxDays" ], "type": "object" }, "analysisUpdatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "blockersByRule": { "items": { "properties": { "closingRole": { "type": "string" }, "count": { "description": "Vigente procedimientos with the rule in this state.", "type": "integer" }, "label": { "description": "Rule title.", "type": "string" }, "order": { "description": "Sort position.", "type": "integer" }, "phase": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "label", "count", "ruleKey", "title", "phase", "order", "closingRole" ], "type": "object" }, "type": "array" }, "byActionCategory": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byClosingWork": { "description": "Procedimientos per closing work group.", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "key": { "description": "Stable key.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "key", "label", "count" ], "type": "object" }, "type": "array" }, "byEstado": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byFamilia": { "description": "Counts per legal family (empresa, persona, simplificada, derivada, desconocida).", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byLiquidador": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byLiquidadorOtros": { "type": "integer" }, "byRegion": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byRegionOtros": { "type": "integer" }, "byRolYear": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "bySource": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byTipo": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byTipoOtros": { "type": "integer" }, "byTribunal": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byTribunalOtros": { "type": "integer" }, "cierresAdministrativosPendientes": { "type": "integer" }, "estados": { "description": "Available status values.", "items": { "type": "string" }, "type": "array" }, "idleBuckets": { "properties": { "counts": { "additionalProperties": { "type": "integer" }, "description": "Vigente procedimientos per idle bucket (keys in idleBuckets.order).", "type": "object" }, "order": { "description": "Sort position.", "items": { "type": "string" }, "type": "array" } }, "required": [ "order", "counts" ], "type": "object" }, "instruccionesPendientes": { "type": "integer" }, "oldest": { "description": "The ten oldest vigente procedimientos.", "items": { "properties": { "ageApprox": { "type": "boolean" }, "ageDays": { "type": "integer" }, "blockers": { "type": "integer" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "familia": { "type": "string" }, "fecha": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "idleDays": { "type": [ "integer", "null" ] }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "pendingTotal": { "type": "integer" }, "publicationsCaptured": { "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "rolYear": { "type": [ "integer", "null" ] }, "source": { "description": "Source label (Liquidador / Boletín público).", "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "verdict": { "type": "string" } }, "required": [ "id", "source", "rol", "nombre", "estado", "tipoProcedimiento", "tribunal", "fecha", "rolYear", "ageDays", "ageApprox", "idleDays", "verdict", "blockers", "pendingTotal", "publicationsCaptured", "familia" ], "type": "object" }, "type": "array" }, "openTasks": { "type": "integer" }, "otras": { "type": "integer" }, "pendingByRule": { "items": { "properties": { "closingRole": { "type": "string" }, "count": { "description": "Vigente procedimientos with the rule in this state.", "type": "integer" }, "label": { "description": "Rule title.", "type": "string" }, "order": { "description": "Sort position.", "type": "integer" }, "phase": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "label", "count", "ruleKey", "title", "phase", "order", "closingRole" ], "type": "object" }, "type": "array" }, "regiones": { "description": "Chilean regions.", "items": { "type": "string" }, "type": "array" }, "terminadas": { "type": "integer" }, "tiposProcedimiento": { "description": "Procedure types.", "items": { "type": "string" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" }, "vencimientosProximos": { "type": "integer" }, "vencimientosVencidos": { "type": "integer" }, "verdictCounts": { "additionalProperties": { "type": "integer" }, "description": "Vigente procedimientos per verdict.", "type": "object" }, "verdictOrder": { "items": { "type": "string" }, "type": "array" }, "vigentes": { "type": "integer" }, "vigentesAsignadas": { "type": "integer" }, "vigentesCasiCerradas": { "type": "integer" }, "vigentesEtapasVencidas": { "type": "integer" }, "vigentesMas5Anios": { "type": "integer" }, "vigentesSinAnalisis": { "type": "integer" }, "vigentesSinAsignar": { "type": "integer" }, "vigentesSinGestion180": { "type": "integer" }, "vigentesSinGestion90": { "type": "integer" }, "vigentesSinPublicaciones": { "type": "integer" } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidaciones reporte general", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/get-liquidations-simplificadas": { "post": { "description": "Get liquidaciones simplificadas\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-get-liquidations-simplificadas", "requestBody": { "content": { "application/json": { "example": { "args": [ { "estado": "", "explainCount": 0, "explainFrom": 0, "omitEvidence": false, "omitExplanation": false, "summary": false } ] }, "schema": { "properties": { "args": { "items": { "properties": { "estado": { "type": "string" }, "explainCount": { "type": "number" }, "explainFrom": { "type": "number" }, "omitEvidence": { "type": "boolean" }, "omitExplanation": { "type": "boolean" }, "summary": { "type": "boolean" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "findings": [ { "id": "string", "ruleKey": "string", "title": "string", "state": "string", "severity": "string", "explanation": "string", "reviewedState": "string", "taskId": "string", "reviewNote": "string", "reviewedAt": "2026-01-31T12:00:00Z", "evidence": { "source": "L", "items": [ "string" ], "references": [ { "id": "string", "source": "publications", "title": "string", "date": "string", "evidenceCandidate": true } ] } } ], "findingCount": 0, "blockerCount": 0, "cierre": { "estado": "string", "motivos": [ "string" ], "detalle": "string" }, "publicationsCount": 0 } ], "byTipoProc": [ { "tipoProcedimiento": "string", "total": 0, "sinPublicaciones": 0, "pendingHigh": 0, "pendingMedium": 0 } ], "updatedAt": "2026-01-31T12:00:00Z" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "byTipoProc": { "items": { "properties": { "pendingHigh": { "type": "integer" }, "pendingMedium": { "type": "integer" }, "sinPublicaciones": { "type": "integer" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "tipoProcedimiento", "total", "sinPublicaciones", "pendingHigh", "pendingMedium" ], "type": "object" }, "type": "array" }, "causas": { "description": "PJUD causas.", "items": { "properties": { "blockerCount": { "type": "integer" }, "cierre": { "properties": { "detalle": { "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "motivos": { "items": { "type": "string" }, "type": "array" } }, "required": [ "estado", "motivos", "detalle" ], "type": "object" }, "findingCount": { "type": "integer" }, "findings": { "items": { "properties": { "evidence": { "description": "Supporting evidence.", "properties": { "items": { "description": "The records returned.", "items": { "type": "string" }, "type": "array" }, "references": { "description": "References.", "items": { "properties": { "date": { "description": "Publication or action date as stored (timestamp string).", "type": [ "string", "null" ] }, "evidenceCandidate": { "description": "The movement reads as evidence for the rule.", "type": "boolean" }, "id": { "description": "Publication or action id.", "type": "string" }, "source": { "description": "Where the record came from.", "enum": [ "publications", "actions" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "title", "date", "evidenceCandidate" ], "type": "object" }, "type": "array" }, "source": { "description": "Source of the procedimiento the finding was evaluated on.", "enum": [ "L", "P" ], "type": "string" } }, "required": [ "source", "items", "references" ], "type": "object" }, "explanation": { "description": "Explanation.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "reviewNote": { "type": "string" }, "reviewedAt": { "format": "date-time", "type": [ "string", "null" ] }, "reviewedState": { "type": "string" }, "ruleKey": { "description": "Key of the rule that produced it.", "type": "string" }, "severity": { "description": "Severity.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "ruleKey", "title", "state", "severity", "explanation", "reviewedState", "taskId", "reviewNote", "reviewedAt", "evidence" ], "type": "object" }, "type": [ "array", "null" ] }, "publicationsCount": { "type": "integer" } }, "type": "object" }, "type": "array" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "causas", "byTipoProc", "updatedAt" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidaciones simplificadas", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/queries/search-liquidacion-related-cause-candidates": { "post": { "description": "Search liquidacion related causa candidates\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-queries-search-liquidacion-related-cause-candidates", "requestBody": { "content": { "application/json": { "example": { "args": [ "" ] }, "schema": { "properties": { "args": { "items": { "type": "string" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "candidates": [ { "id": "string", "rol": "string", "competence": "SUPREMA", "caratulado": "string", "corteId": 0, "tribunalId": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "candidates": { "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "enum": [ "SUPREMA", "APELACIONES", "CIVIL", "LABORAL", "PENAL", "COBRANZA", "FAMILIA" ], "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "rol", "competence", "caratulado", "corteId", "tribunalId" ], "type": "object" }, "type": "array" } }, "required": [ "candidates" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search liquidacion related causa candidates", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/superir/get-honorario30-ufdocument-url": { "post": { "description": "Get honorario30 UF document url\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-get-honorario30-ufdocument-url", "requestBody": { "content": { "application/json": { "example": { "args": [ { "path": "", "procedimientoId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "path": { "type": "string" }, "procedimientoId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "previewUrl": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "previewUrl": { "description": "Short-lived URL to preview the file.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get honorario30 UF document url", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/superir/get-honorario30-ufdocumentos": { "post": { "description": "Get honorario30 UF documentos\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-get-honorario30-ufdocumentos", "requestBody": { "content": { "application/json": { "example": { "args": [ { "procedimientoId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "procedimientoId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "documentos": [ { "id": "string", "nombre": "string", "ingreso": "string", "slot": "string", "slotLabel": "string", "path": "string", "read": true, "problems": [ "string" ] } ], "faltantes": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "documentos": { "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "ingreso": { "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "path": { "description": "Path relative to the API host.", "type": "string" }, "problems": { "items": { "type": "string" }, "type": "array" }, "read": { "description": "Whether the API key's acting user has read it.", "type": "boolean" }, "slot": { "type": "string" }, "slotLabel": { "type": "string" } }, "required": [ "id", "nombre", "ingreso", "read", "problems" ], "type": "object" }, "type": "array" }, "faltantes": { "items": { "type": "string" }, "type": "array" } }, "required": [ "documentos", "faltantes" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get honorario30 UF documentos", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/superir/get-honorarios30-uf": { "post": { "description": "Get honorarios30 UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-get-honorarios30-uf", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "procedimientoId": "string", "cbcId": "string", "rol": "string", "tribunal": "string", "deudor": "string", "tipoProcedimiento": "string", "estadoProcedimiento": "string", "origen": "string", "estadoFlujo": "string", "acciones": { "\u003ckey\u003e": true }, "historia": {}, "seenAt": "2026-01-31T12:00:00Z" } ], "counts": { "\u003ckey\u003e": 0 }, "syncedAt": "2026-01-31T12:00:00Z" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "counts": { "additionalProperties": { "type": "integer" }, "description": "Rows per state: ELEGIBLE, or the portal flow state of a SOLICITUD.", "type": "object" }, "rows": { "description": "The records on this page.", "items": { "properties": { "acciones": { "additionalProperties": { "type": "boolean" }, "description": "Actions the portal offers on the request (complementa, reposicion, revision, boleta).", "type": "object" }, "cbcId": { "type": "string" }, "deudor": { "type": "string" }, "estadoFlujo": { "type": "string" }, "estadoProcedimiento": { "type": "string" }, "historia": { "description": "Portal history of the request: {movimientos: [rows keyed by portal column], ingresos: [{numero, materia, fecha, ...}]}." }, "origen": { "description": "Where the case came from.", "type": "string" }, "procedimientoId": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "seenAt": { "format": "date-time", "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "procedimientoId", "rol", "tribunal", "deudor", "tipoProcedimiento", "estadoProcedimiento", "origen", "acciones", "seenAt" ], "type": "object" }, "type": "array" }, "syncedAt": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "rows", "counts", "syncedAt" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get honorarios30 UF", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/superir/get-solicitud30-uf": { "post": { "description": "Get solicitud30 UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-get-solicitud30-uf", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "estado": { "procedimientoId": "string", "cbcId": "string", "rol": "string", "tribunal": "string", "deudor": "string", "tipoProcedimiento": "string", "estadoProcedimiento": "string", "origen": "string", "estadoFlujo": "string", "acciones": { "\u003ckey\u003e": true }, "historia": {}, "seenAt": "2026-01-31T12:00:00Z" }, "slots": [ { "field": "string", "label": "string", "required": true, "candidates": [ { "sourceId": "string", "titulo": "string", "fecha": "2026-01-31T12:00:00Z" } ] } ], "fechaAprobacion": "string", "boletasDesde": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "boletasDesde": { "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "properties": { "acciones": { "additionalProperties": { "type": "boolean" }, "description": "Actions the portal offers on the request (complementa, reposicion, revision, boleta).", "type": "object" }, "cbcId": { "type": "string" }, "deudor": { "type": "string" }, "estadoFlujo": { "type": "string" }, "estadoProcedimiento": { "type": "string" }, "historia": { "description": "Portal history of the request: {movimientos: [rows keyed by portal column], ingresos: [{numero, materia, fecha, ...}]}." }, "origen": { "description": "Where the case came from.", "type": "string" }, "procedimientoId": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "seenAt": { "format": "date-time", "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "procedimientoId", "rol", "tribunal", "deudor", "tipoProcedimiento", "estadoProcedimiento", "origen", "acciones", "seenAt" ], "type": [ "object", "null" ] }, "fechaAprobacion": { "type": "string" }, "slots": { "items": { "properties": { "candidates": { "items": { "properties": { "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "sourceId": { "description": "Id of the record in its source.", "type": "string" }, "titulo": { "description": "Title.", "type": "string" } }, "required": [ "sourceId", "titulo" ], "type": "object" }, "type": "array" }, "field": { "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "required": { "type": "boolean" } }, "required": [ "field", "label", "required", "candidates" ], "type": "object" }, "type": "array" } }, "required": [ "estado", "slots", "fechaAprobacion", "boletasDesde" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get solicitud30 UF", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/superir/get-superir-form": { "post": { "description": "Get superir form\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-get-superir-form", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "kind": "string", "options": {}, "history": {}, "today": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "history": { "description": "Rows of the portal's history table for this form, each an object keyed by the table's column headers (column index when a header is empty), plus documento when the row links one." }, "kind": { "description": "Record subtype.", "type": "string" }, "options": { "description": "Select options of the portal form, keyed by field name; each value is an array of {value, label, refiereOficio?}." }, "today": { "type": "string" } }, "required": [ "kind", "options", "history", "today" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get superir form", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/superir/get-superir-overview": { "post": { "description": "Get superir overview\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-get-superir-overview", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rol": "string", "honorarios30UF": [ { "procedimientoId": "string", "cbcId": "string", "rol": "string", "tribunal": "string", "deudor": "string", "tipoProcedimiento": "string", "estadoProcedimiento": "string", "origen": "ELEGIBLE", "estadoFlujo": "string", "acciones": { "\u003ckey\u003e": true }, "historia": {}, "seenAt": "2026-01-31T12:00:00Z" } ], "consultas": { "registroCivil": { "data": { "padres": [ { "relacion": "string", "nombre": "string", "rut": "string", "fechaNacimiento": "string", "fechaDefuncion": "string", "posesionEfectiva": "string" } ], "vehiculos": [ { "patente": "string", "tipo": "string", "marca": "string", "modelo": "string", "anio": "string", "color": "string", "nroMotor": "string", "chasis": "string", "vin": "string", "propietarios": [ { "nombre": "string", "rut": "string", "fechaAdquisicion": "string", "oficinaInscripcion": "string", "nroInscripcion": "string" } ], "anotaciones": [ { "anotacion": "string", "acreedor": "string", "fechaRepertorio": "string", "repertorio": "string", "numeroRepertorio": "string", "numeroDocumentoRol": "string" } ], "error": "string" } ] }, "consultedAt": "2026-01-31T12:00:00Z" }, "cmf": { "resumen": [ { "tipo": "string", "nombre": "string", "desde": "string", "hasta": "string", "meses": 0 } ], "registros": 0, "consultedAt": "2026-01-31T12:00:00Z" } }, "cruces": { "vehiculosNoEnBienes": [ "string" ], "cmfSinCreditoVerificado": [ "string" ] }, "envios": [ { "id": "string", "kind": "string", "values": {}, "fileName": "string", "bienId": "string", "state": "SENDING", "receipt": { "\u003ckey\u003e": "string" }, "error": "string", "createdAt": "string", "by": "string" } ], "sugerencias": { "ventasDirectas": [ { "id": "string", "tipo": "string", "descripcion": "string", "estadoRealizacion": "string", "fechaRealizacion": "string", "montoRealizacion": 0, "origen": "string", "informada": true } ], "direcciones": [ "string" ], "avisos": [ { "clave": "cuenta-final", "asunto": "string", "desde": "2026-01-31", "vence": "2026-01-31", "informado": true, "comentarios": "string" } ] }, "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" }, "consultas": { "properties": { "cmf": { "description": "Cached CMF debt consulta, grouped per institution.", "properties": { "consultedAt": { "format": "date-time", "type": "string" }, "registros": { "description": "Monthly CMF rows read.", "type": "integer" }, "resumen": { "items": { "properties": { "desde": { "description": "First period informed.", "type": "string" }, "hasta": { "description": "Last period informed.", "type": "string" }, "meses": { "type": "integer" }, "nombre": { "description": "Institution.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "tipo", "nombre", "desde", "hasta", "meses" ], "type": "object" }, "type": "array" } }, "required": [ "resumen", "registros", "consultedAt" ], "type": "object" }, "registroCivil": { "description": "Cached Registro Civil consulta (parents and vehicles).", "properties": { "consultedAt": { "format": "date-time", "type": "string" }, "data": { "properties": { "padres": { "items": { "properties": { "fechaDefuncion": { "type": "string" }, "fechaNacimiento": { "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "posesionEfectiva": { "type": "string" }, "relacion": { "description": "Madre or Padre.", "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" } }, "required": [ "relacion" ], "type": "object" }, "type": [ "array", "null" ] }, "vehiculos": { "items": { "properties": { "anio": { "type": "string" }, "anotaciones": { "items": { "properties": { "acreedor": { "type": "string" }, "anotacion": { "type": "string" }, "fechaRepertorio": { "type": "string" }, "numeroDocumentoRol": { "type": "string" }, "numeroRepertorio": { "type": "string" }, "repertorio": { "type": "string" } }, "required": [ "anotacion" ], "type": "object" }, "type": [ "array", "null" ] }, "chasis": { "type": "string" }, "color": { "type": "string" }, "error": { "description": "The patente's detail could not be read.", "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "nroMotor": { "type": "string" }, "patente": { "type": "string" }, "propietarios": { "items": { "properties": { "fechaAdquisicion": { "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "nroInscripcion": { "type": "string" }, "oficinaInscripcion": { "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" } }, "required": [ "nombre" ], "type": "object" }, "type": [ "array", "null" ] }, "tipo": { "description": "Record type.", "type": "string" }, "vin": { "type": "string" } }, "required": [ "patente", "propietarios", "anotaciones" ], "type": "object" }, "type": [ "array", "null" ] } }, "required": [ "padres", "vehiculos" ], "type": "object" } }, "required": [ "data", "consultedAt" ], "type": "object" } }, "type": "object" }, "cruces": { "properties": { "cmfSinCreditoVerificado": { "description": "CMF institutions no verified crédito names.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "vehiculosNoEnBienes": { "description": "Patentes from the Registro Civil no bien mentions.", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "envios": { "description": "Last 100 sends, newest first.", "items": { "properties": { "bienId": { "type": [ "string", "null" ] }, "by": { "description": "Sender name or email.", "type": [ "string", "null" ] }, "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "error": { "type": [ "string", "null" ] }, "fileName": { "description": "Original file name.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Superintendencia form kind, or treinta-uf.", "type": "string" }, "receipt": { "additionalProperties": { "type": "string" }, "description": "Portal row that confirmed the send.", "type": [ "object", "null" ] }, "state": { "description": "Current state.", "enum": [ "SENDING", "CONFIRMED", "SENT_UNVERIFIED", "FAILED" ], "type": "string" }, "values": { "description": "Values sent: the form fields keyed by name (a 30 UF request stores fechaResolucion, comentarios, documentos, boletas)." } }, "required": [ "id", "kind", "values", "fileName", "bienId", "state", "receipt", "error", "createdAt", "by" ], "type": "object" }, "type": "array" }, "honorarios30UF": { "description": "30 UF register rows of this procedimiento; null when the read failed.", "items": { "properties": { "acciones": { "additionalProperties": { "type": "boolean" }, "description": "Actions the portal offers on the request (complementa, reposicion, revision, boleta).", "type": "object" }, "cbcId": { "type": "string" }, "deudor": { "type": "string" }, "estadoFlujo": { "type": "string" }, "estadoProcedimiento": { "type": "string" }, "historia": { "description": "Portal history of the request: {movimientos: [rows keyed by portal column], ingresos: [{numero, materia, fecha, ...}]}." }, "origen": { "description": "Where the case came from.", "enum": [ "ELEGIBLE", "SOLICITUD" ], "type": "string" }, "procedimientoId": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "seenAt": { "format": "date-time", "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "procedimientoId", "rol", "tribunal", "deudor", "tipoProcedimiento", "estadoProcedimiento", "origen", "acciones", "seenAt" ], "type": "object" }, "type": [ "array", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "sugerencias": { "properties": { "avisos": { "items": { "properties": { "asunto": { "type": "string" }, "clave": { "enum": [ "cuenta-final", "termino" ], "type": "string" }, "comentarios": { "description": "Prefilled message.", "type": "string" }, "desde": { "format": "date", "type": "string" }, "informado": { "type": "boolean" }, "vence": { "format": "date", "type": "string" } }, "required": [ "clave", "asunto", "desde", "informado", "comentarios" ], "type": "object" }, "type": "array" }, "direcciones": { "description": "Descriptions of the inmuebles.", "items": { "type": "string" }, "type": "array" }, "ventasDirectas": { "items": { "properties": { "descripcion": { "type": "string" }, "estadoRealizacion": { "type": "string" }, "fechaRealizacion": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "informada": { "description": "Already reported to the Superintendencia.", "type": "boolean" }, "montoRealizacion": { "type": [ "integer", "null" ] }, "origen": { "description": "Where the case came from.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "id", "tipo", "descripcion", "estadoRealizacion", "fechaRealizacion", "montoRealizacion", "origen", "informada" ], "type": "object" }, "type": "array" } }, "required": [ "ventasDirectas", "direcciones", "avisos" ], "type": "object" } }, "required": [ "rol", "honorarios30UF", "consultas", "cruces", "envios", "sugerencias", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get superir overview", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/superir/get-superir-uf": { "post": { "description": "Get superir UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-get-superir-uf", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "fecha": "string", "valor": 0, "formatted": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "fecha": { "description": "Date (ISO 8601).", "type": "string" }, "formatted": { "type": "string" }, "valor": { "type": "number" } }, "required": [ "fecha", "valor", "formatted" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get superir UF", "tags": [ "Liquidations" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidations/superir/run-superir-consulta": { "post": { "description": "Run superir consulta\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-run-superir-consulta", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rol": "string", "honorarios30UF": [ { "procedimientoId": "string", "cbcId": "string", "rol": "string", "tribunal": "string", "deudor": "string", "tipoProcedimiento": "string", "estadoProcedimiento": "string", "origen": "ELEGIBLE", "estadoFlujo": "string", "acciones": { "\u003ckey\u003e": true }, "historia": {}, "seenAt": "2026-01-31T12:00:00Z" } ], "consultas": { "registroCivil": { "data": { "padres": [ { "relacion": "string", "nombre": "string", "rut": "string", "fechaNacimiento": "string", "fechaDefuncion": "string", "posesionEfectiva": "string" } ], "vehiculos": [ { "patente": "string", "tipo": "string", "marca": "string", "modelo": "string", "anio": "string", "color": "string", "nroMotor": "string", "chasis": "string", "vin": "string", "propietarios": [ { "nombre": "string", "rut": "string", "fechaAdquisicion": "string", "oficinaInscripcion": "string", "nroInscripcion": "string" } ], "anotaciones": [ { "anotacion": "string", "acreedor": "string", "fechaRepertorio": "string", "repertorio": "string", "numeroRepertorio": "string", "numeroDocumentoRol": "string" } ], "error": "string" } ] }, "consultedAt": "2026-01-31T12:00:00Z" }, "cmf": { "resumen": [ { "tipo": "string", "nombre": "string", "desde": "string", "hasta": "string", "meses": 0 } ], "registros": 0, "consultedAt": "2026-01-31T12:00:00Z" } }, "cruces": { "vehiculosNoEnBienes": [ "string" ], "cmfSinCreditoVerificado": [ "string" ] }, "envios": [ { "id": "string", "kind": "string", "values": {}, "fileName": "string", "bienId": "string", "state": "SENDING", "receipt": { "\u003ckey\u003e": "string" }, "error": "string", "createdAt": "string", "by": "string" } ], "sugerencias": { "ventasDirectas": [ { "id": "string", "tipo": "string", "descripcion": "string", "estadoRealizacion": "string", "fechaRealizacion": "string", "montoRealizacion": 0, "origen": "string", "informada": true } ], "direcciones": [ "string" ], "avisos": [ { "clave": "cuenta-final", "asunto": "string", "desde": "2026-01-31", "vence": "2026-01-31", "informado": true, "comentarios": "string" } ] }, "canManage": true } }, "schema": { "properties": { "data": { "description": "The Superintendencia overview after the consulta.", "properties": { "canManage": { "type": "boolean" }, "consultas": { "properties": { "cmf": { "description": "Cached CMF debt consulta, grouped per institution.", "properties": { "consultedAt": { "format": "date-time", "type": "string" }, "registros": { "description": "Monthly CMF rows read.", "type": "integer" }, "resumen": { "items": { "properties": { "desde": { "description": "First period informed.", "type": "string" }, "hasta": { "description": "Last period informed.", "type": "string" }, "meses": { "type": "integer" }, "nombre": { "description": "Institution.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "tipo", "nombre", "desde", "hasta", "meses" ], "type": "object" }, "type": "array" } }, "required": [ "resumen", "registros", "consultedAt" ], "type": "object" }, "registroCivil": { "description": "Cached Registro Civil consulta (parents and vehicles).", "properties": { "consultedAt": { "format": "date-time", "type": "string" }, "data": { "properties": { "padres": { "items": { "properties": { "fechaDefuncion": { "type": "string" }, "fechaNacimiento": { "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "posesionEfectiva": { "type": "string" }, "relacion": { "description": "Madre or Padre.", "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" } }, "required": [ "relacion" ], "type": "object" }, "type": [ "array", "null" ] }, "vehiculos": { "items": { "properties": { "anio": { "type": "string" }, "anotaciones": { "items": { "properties": { "acreedor": { "type": "string" }, "anotacion": { "type": "string" }, "fechaRepertorio": { "type": "string" }, "numeroDocumentoRol": { "type": "string" }, "numeroRepertorio": { "type": "string" }, "repertorio": { "type": "string" } }, "required": [ "anotacion" ], "type": "object" }, "type": [ "array", "null" ] }, "chasis": { "type": "string" }, "color": { "type": "string" }, "error": { "description": "The patente's detail could not be read.", "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "nroMotor": { "type": "string" }, "patente": { "type": "string" }, "propietarios": { "items": { "properties": { "fechaAdquisicion": { "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "nroInscripcion": { "type": "string" }, "oficinaInscripcion": { "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" } }, "required": [ "nombre" ], "type": "object" }, "type": [ "array", "null" ] }, "tipo": { "description": "Record type.", "type": "string" }, "vin": { "type": "string" } }, "required": [ "patente", "propietarios", "anotaciones" ], "type": "object" }, "type": [ "array", "null" ] } }, "required": [ "padres", "vehiculos" ], "type": "object" } }, "required": [ "data", "consultedAt" ], "type": "object" } }, "type": "object" }, "cruces": { "properties": { "cmfSinCreditoVerificado": { "description": "CMF institutions no verified crédito names.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "vehiculosNoEnBienes": { "description": "Patentes from the Registro Civil no bien mentions.", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "envios": { "description": "Last 100 sends, newest first.", "items": { "properties": { "bienId": { "type": [ "string", "null" ] }, "by": { "description": "Sender name or email.", "type": [ "string", "null" ] }, "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "error": { "type": [ "string", "null" ] }, "fileName": { "description": "Original file name.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Superintendencia form kind, or treinta-uf.", "type": "string" }, "receipt": { "additionalProperties": { "type": "string" }, "description": "Portal row that confirmed the send.", "type": [ "object", "null" ] }, "state": { "description": "Current state.", "enum": [ "SENDING", "CONFIRMED", "SENT_UNVERIFIED", "FAILED" ], "type": "string" }, "values": { "description": "Values sent: the form fields keyed by name (a 30 UF request stores fechaResolucion, comentarios, documentos, boletas)." } }, "required": [ "id", "kind", "values", "fileName", "bienId", "state", "receipt", "error", "createdAt", "by" ], "type": "object" }, "type": "array" }, "honorarios30UF": { "description": "30 UF register rows of this procedimiento; null when the read failed.", "items": { "properties": { "acciones": { "additionalProperties": { "type": "boolean" }, "description": "Actions the portal offers on the request (complementa, reposicion, revision, boleta).", "type": "object" }, "cbcId": { "type": "string" }, "deudor": { "type": "string" }, "estadoFlujo": { "type": "string" }, "estadoProcedimiento": { "type": "string" }, "historia": { "description": "Portal history of the request: {movimientos: [rows keyed by portal column], ingresos: [{numero, materia, fecha, ...}]}." }, "origen": { "description": "Where the case came from.", "enum": [ "ELEGIBLE", "SOLICITUD" ], "type": "string" }, "procedimientoId": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "seenAt": { "format": "date-time", "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "procedimientoId", "rol", "tribunal", "deudor", "tipoProcedimiento", "estadoProcedimiento", "origen", "acciones", "seenAt" ], "type": "object" }, "type": [ "array", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "sugerencias": { "properties": { "avisos": { "items": { "properties": { "asunto": { "type": "string" }, "clave": { "enum": [ "cuenta-final", "termino" ], "type": "string" }, "comentarios": { "description": "Prefilled message.", "type": "string" }, "desde": { "format": "date", "type": "string" }, "informado": { "type": "boolean" }, "vence": { "format": "date", "type": "string" } }, "required": [ "clave", "asunto", "desde", "informado", "comentarios" ], "type": "object" }, "type": "array" }, "direcciones": { "description": "Descriptions of the inmuebles.", "items": { "type": "string" }, "type": "array" }, "ventasDirectas": { "items": { "properties": { "descripcion": { "type": "string" }, "estadoRealizacion": { "type": "string" }, "fechaRealizacion": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "informada": { "description": "Already reported to the Superintendencia.", "type": "boolean" }, "montoRealizacion": { "type": [ "integer", "null" ] }, "origen": { "description": "Where the case came from.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "id", "tipo", "descripcion", "estadoRealizacion", "fechaRealizacion", "montoRealizacion", "origen", "informada" ], "type": "object" }, "type": "array" } }, "required": [ "ventasDirectas", "direcciones", "avisos" ], "type": "object" } }, "required": [ "rol", "honorarios30UF", "consultas", "cruces", "envios", "sugerencias", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Run superir consulta", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/superir/send-solicitud30-uf": { "post": { "description": "Send solicitud30 UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-send-solicitud30-uf", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "state": "string", "duplicate": true, "receipt": { "estadoFlujo": "string", "rol": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "duplicate": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "receipt": { "description": "Portal row that confirmed the request.", "properties": { "estadoFlujo": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "estadoFlujo", "rol" ], "type": [ "object", "null" ] }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "state" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send solicitud30 UF", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/superir/send-superir-delivery": { "post": { "description": "Send superir envio\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-send-superir-delivery", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "state": "string", "duplicate": true, "receipt": { "\u003ckey\u003e": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "duplicate": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "receipt": { "additionalProperties": { "type": "string" }, "description": "Portal history row that confirmed the send, keyed by column header; null when it could not be told apart.", "type": [ "object", "null" ] }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "state" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send superir envio", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidations/superir/sync-honorarios30-uf": { "post": { "description": "Sync honorarios30 UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidations-superir-sync-honorarios30-uf", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "procedimientoId": "string", "cbcId": "string", "rol": "string", "tribunal": "string", "deudor": "string", "tipoProcedimiento": "string", "estadoProcedimiento": "string", "origen": "string", "estadoFlujo": "string", "acciones": { "\u003ckey\u003e": true }, "historia": {}, "seenAt": "2026-01-31T12:00:00Z" } ], "counts": { "\u003ckey\u003e": 0 }, "syncedAt": "2026-01-31T12:00:00Z" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "counts": { "additionalProperties": { "type": "integer" }, "description": "Rows per state: ELEGIBLE, or the portal flow state of a SOLICITUD.", "type": "object" }, "rows": { "description": "The records on this page.", "items": { "properties": { "acciones": { "additionalProperties": { "type": "boolean" }, "description": "Actions the portal offers on the request (complementa, reposicion, revision, boleta).", "type": "object" }, "cbcId": { "type": "string" }, "deudor": { "type": "string" }, "estadoFlujo": { "type": "string" }, "estadoProcedimiento": { "type": "string" }, "historia": { "description": "Portal history of the request: {movimientos: [rows keyed by portal column], ingresos: [{numero, materia, fecha, ...}]}." }, "origen": { "description": "Where the case came from.", "type": "string" }, "procedimientoId": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "seenAt": { "format": "date-time", "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "procedimientoId", "rol", "tribunal", "deudor", "tipoProcedimiento", "estadoProcedimiento", "origen", "acciones", "seenAt" ], "type": "object" }, "type": "array" }, "syncedAt": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "rows", "counts", "syncedAt" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Sync honorarios30 UF", "tags": [ "Liquidations" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/extract-all-for-org": { "post": { "description": "Extract all for org\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-extract-all-for-org", "requestBody": { "content": { "application/json": { "example": { "args": [ { "limitPerCausa": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "limitPerCausa": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "orgId": "string", "started": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "orgId": { "description": "Organization id.", "type": "string" }, "started": { "type": "boolean" } }, "required": [ "orgId", "started" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract all for org", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-acta": { "post": { "description": "Extract liquidator bienes acta\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-extract-liquidator-bienes-acta", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "read": 0, "actasCreated": 0, "bienesCreated": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "actasCreated": { "type": "integer" }, "bienesCreated": { "type": "integer" }, "read": { "description": "Whether the API key's acting user has read it.", "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "read", "actasCreated", "bienesCreated", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract liquidator bienes acta", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-bases-remate": { "post": { "description": "Extract liquidator bienes bases remate\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-extract-liquidator-bienes-bases-remate", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "read": 0, "created": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "created": { "type": "integer" }, "read": { "description": "Whether the API key's acting user has read it.", "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "read", "created", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract liquidator bienes bases remate", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-oficios": { "post": { "description": "Extract liquidator bienes oficios\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-extract-liquidator-bienes-oficios", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "read": 0, "oficiosCreated": 0, "bienesCreated": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "bienesCreated": { "type": "integer" }, "oficiosCreated": { "type": "integer" }, "read": { "description": "Whether the API key's acting user has read it.", "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "read", "oficiosCreated", "bienesCreated", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract liquidator bienes oficios", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-rendiciones": { "post": { "description": "Extract liquidator bienes rendiciones\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-extract-liquidator-bienes-rendiciones", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "read": 0, "created": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "created": { "type": "integer" }, "read": { "description": "Whether the API key's acting user has read it.", "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "read", "created", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract liquidator bienes rendiciones", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-request": { "post": { "description": "Extract liquidator bienes solicitud\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-extract-liquidator-bienes-request", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "read": 0, "created": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "created": { "type": "integer" }, "read": { "description": "Whether the API key's acting user has read it.", "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "read", "created", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract liquidator bienes solicitud", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/extract-pending-for-cause": { "post": { "description": "Extract pending for causa\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-extract-pending-for-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "cbcId": "string", "rol": "string", "solicitudRead": 0, "solicitudCreated": 0, "actaRead": 0, "actaCreated": 0, "actaBienesCreated": 0, "oficioRead": 0, "oficioCreated": 0, "oficioBienesCreated": 0, "rendicionRead": 0, "rendicionCreated": 0, "basesRemateRead": 0, "basesRemateCreated": 0, "realizacionMatched": 0, "error": "string", "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "actaBienesCreated": { "type": "integer" }, "actaCreated": { "type": "integer" }, "actaRead": { "type": "integer" }, "basesRemateCreated": { "type": "integer" }, "basesRemateRead": { "type": "integer" }, "cbcId": { "type": "string" }, "error": { "type": "string" }, "oficioBienesCreated": { "type": "integer" }, "oficioCreated": { "type": "integer" }, "oficioRead": { "type": "integer" }, "realizacionMatched": { "type": "integer" }, "rendicionCreated": { "type": "integer" }, "rendicionRead": { "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "solicitudCreated": { "type": "integer" }, "solicitudRead": { "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "cbcId", "rol", "solicitudRead", "solicitudCreated", "actaRead", "actaCreated", "actaBienesCreated", "oficioRead", "oficioCreated", "oficioBienesCreated", "rendicionRead", "rendicionCreated", "basesRemateRead", "basesRemateCreated", "realizacionMatched" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract pending for causa", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/prioritize-liquidator-bienes-extraction": { "post": { "description": "Prioritize liquidator bienes extraction\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-prioritize-liquidator-bienes-extraction", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "queued": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "queued": { "type": "boolean" } }, "required": [ "queued" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Prioritize liquidator bienes extraction", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-bienes/mutations/record-liquidator-bien-disposition": { "post": { "description": "Record liquidator bien disposition\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-record-liquidator-bien-disposition", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "bienId": "string", "tipo": "string", "state": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "bienId": { "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "bienId", "tipo", "state" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Record liquidator bien disposition", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/review-liquidator-bien": { "post": { "description": "Review liquidator bien\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-review-liquidator-bien", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "state": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "state" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Review liquidator bien", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/review-liquidator-realization-event": { "post": { "description": "Review liquidator realization event\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-review-liquidator-realization-event", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "eventId": "string", "bienId": "string", "state": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "bienId": { "type": "string" }, "eventId": { "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "eventId", "bienId", "state" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Review liquidator realization event", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/review-liquidator-rendicion": { "post": { "description": "Review liquidator rendicion\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-review-liquidator-rendicion", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "state": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "state" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Review liquidator rendicion", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/mutations/sync-liquidator-bienes-realizacion": { "post": { "description": "Sync liquidator bienes realizacion\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-mutations-sync-liquidator-bienes-realizacion", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "updated": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "updated": { "description": "Whether anything changed.", "type": "integer" } }, "required": [ "updated" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Sync liquidator bienes realizacion", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-bienes/queries/get-liquidator-bienes-summary": { "post": { "description": "Get liquidator bienes summary\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-bienes-queries-get-liquidator-bienes-summary", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidator bienes summary", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-credits/mutations/cross-match-deudor-rut": { "post": { "description": "Cross match deudor rut\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-cross-match-deudor-rut", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "linked": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "linked": { "type": "integer" } }, "required": [ "linked" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Cross match deudor rut", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/delete-liquidator-credit": { "post": { "description": "Delete liquidator credit\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-delete-liquidator-credit", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "deleted": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "deleted": { "description": "Whether the record was deleted.", "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id", "deleted" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete liquidator credit", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/extract-all-for-org": { "post": { "description": "Extract all for org\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-extract-all-for-org", "requestBody": { "content": { "application/json": { "example": { "args": [ { "limitPerCausa": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "limitPerCausa": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "orgId": "string", "started": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "orgId": { "description": "Organization id.", "type": "string" }, "started": { "type": "boolean" } }, "required": [ "orgId", "started" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract all for org", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/extract-compilado-content": { "post": { "description": "Extract compilado content\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-extract-compilado-content", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "matched": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "matched": { "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "matched", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract compilado content", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/extract-credito-objecion": { "post": { "description": "Extract credito objecion\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-extract-credito-objecion", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "matched": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "matched": { "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "matched", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract credito objecion", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/extract-liquidator-credits": { "post": { "description": "Extract liquidator credits\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-extract-liquidator-credits", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "read": 0, "created": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "created": { "type": "integer" }, "read": { "description": "Whether the API key's acting user has read it.", "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "read", "created", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract liquidator credits", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/extract-nomina-content": { "post": { "description": "Extract nomina content\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-extract-nomina-content", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "matched": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "matched": { "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "matched", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract nomina content", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/extract-pending-for-cause": { "post": { "description": "Extract pending for causa\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-extract-pending-for-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "cbcId": "string", "rol": "string", "read": 0, "created": 0, "objecionesRead": 0, "objecionesMatched": 0, "nominaRead": 0, "nominaMatched": 0, "resolucionesRead": 0, "resolucionesMatched": 0, "compiladoRead": 0, "compiladoMatched": 0, "cierreOrdinarioRead": 0, "cierreOrdinarioMatched": 0, "error": "string", "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "cbcId": { "type": "string" }, "cierreOrdinarioMatched": { "type": "integer" }, "cierreOrdinarioRead": { "type": "integer" }, "compiladoMatched": { "type": "integer" }, "compiladoRead": { "type": "integer" }, "created": { "type": "integer" }, "error": { "type": "string" }, "nominaMatched": { "type": "integer" }, "nominaRead": { "type": "integer" }, "objecionesMatched": { "type": "integer" }, "objecionesRead": { "type": "integer" }, "read": { "description": "Whether the API key's acting user has read it.", "type": "integer" }, "resolucionesMatched": { "type": "integer" }, "resolucionesRead": { "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "cbcId", "rol", "read", "created", "objecionesRead", "objecionesMatched", "nominaRead", "nominaMatched", "resolucionesRead", "resolucionesMatched", "compiladoRead", "compiladoMatched", "cierreOrdinarioRead", "cierreOrdinarioMatched" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract pending for causa", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/extract-resolucion-verificacion": { "post": { "description": "Extract resolucion verificacion\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-extract-resolucion-verificacion", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "matched": 0, "warnings": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "matched": { "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "matched", "warnings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Extract resolucion verificacion", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/publish-compilado-creditos": { "post": { "description": "Publish compilado creditos\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-publish-compilado-creditos", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "jobId": "string", "escrito": { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "2026-01-31T12:00:00Z", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "label": "string" }, "skipped": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "escrito": { "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "docPath": { "type": "string" }, "draftArtifactId": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": "string" }, "eventoId": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "selection": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "uploadJobId": { "type": "string" } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "label" ], "type": "object" }, "jobId": { "description": "Background job id.", "type": "string" }, "skipped": { "description": "Number of items skipped.", "items": { "type": "string" }, "type": "array" } }, "required": [ "jobId", "escrito", "skipped" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Publish compilado creditos", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/request-extraction": { "post": { "description": "Request extraction\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-request-extraction", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "queued": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "queued": { "type": "boolean" } }, "required": [ "queued" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Request extraction", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/review-liquidator-credit": { "post": { "description": "Review liquidator credit\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-review-liquidator-credit", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "state": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "state" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Review liquidator credit", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/mutations/upsert-liquidator-credit": { "post": { "description": "Upsert liquidator credit\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-mutations-upsert-liquidator-credit", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "montoTotal": 0, "periodo": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "montoTotal": { "type": "integer" }, "periodo": { "type": "string" } }, "required": [ "id", "montoTotal", "periodo" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upsert liquidator credit", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-credits/queries/get-liquidador-automation-status": { "post": { "description": "Get liquidador automation status\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-queries-get-liquidador-automation-status", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "id": "string", "rol": "string", "nombre": "string", "tipoProcedimiento": "string", "familia": "string", "cierrePeriodoOrdinario": { "key": "string", "title": "string", "legalBasis": "string", "note": "string", "baseEvent": "string", "baseDate": "2026-01-31T12:00:00Z", "dueDate": "2026-01-31T12:00:00Z", "days": 0, "businessDays": true, "dayRule": "corridos", "dayRuleLabel": "string", "approx": true, "status": "cumplido", "doneEvent": "string", "doneDate": "2026-01-31T12:00:00Z", "daysLeft": 0 }, "nominaCreditosReconocidos": { "key": "string", "title": "string", "legalBasis": "string", "note": "string", "baseEvent": "string", "baseDate": "2026-01-31T12:00:00Z", "dueDate": "2026-01-31T12:00:00Z", "days": 0, "businessDays": true, "dayRule": "corridos", "dayRuleLabel": "string", "approx": true, "status": "cumplido", "doneEvent": "string", "doneDate": "2026-01-31T12:00:00Z", "daysLeft": 0 }, "necesitaAmpliacionONomina": true, "motivoAmpliacion": "string", "pendingCreditos": 0, "pendingObjeciones": 0, "pendingResoluciones": 0, "pendingNomina": 0, "pendingCompilado": 0, "pendingBienesSolicitud": 0, "pendingBienesActa": 0, "pendingBienesOficios": 0, "pendingBienesRendiciones": 0, "compiladoOrdinarioListo": true } ], "issues": [ { "cbcId": "string", "rol": "string", "identifier": "string", "url": "string", "status": "string", "failedAreas": [ "string" ], "lastError": "string", "lastFailedAt": "2026-01-31T12:00:00Z" } ], "canManage": true, "isSuperAdmin": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" }, "causas": { "description": "PJUD causas.", "items": { "properties": { "cierrePeriodoOrdinario": { "description": "Plazo closing the ordinary verification period.", "properties": { "approx": { "type": "boolean" }, "baseDate": { "format": "date-time", "type": "string" }, "baseEvent": { "type": "string" }, "businessDays": { "type": "boolean" }, "dayRule": { "enum": [ "corridos", "habiles_art7", "habiles_lunes_viernes" ], "type": "string" }, "dayRuleLabel": { "type": "string" }, "days": { "description": "Number of days.", "type": "integer" }, "daysLeft": { "type": "integer" }, "doneDate": { "format": "date-time", "type": "string" }, "doneEvent": { "type": "string" }, "dueDate": { "description": "Due date (ISO 8601).", "format": "date-time", "type": "string" }, "key": { "description": "Stable key.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "note": { "description": "Free-text note.", "type": "string" }, "status": { "description": "Current status.", "enum": [ "cumplido", "vencido", "vigente", "verificar" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "key", "title", "legalBasis", "note", "baseEvent", "baseDate", "dueDate", "days", "businessDays", "dayRule", "dayRuleLabel", "approx", "status", "daysLeft" ], "type": "object" }, "compiladoOrdinarioListo": { "type": "boolean" }, "familia": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "motivoAmpliacion": { "type": "string" }, "necesitaAmpliacionONomina": { "description": "Heuristic: an ampliación or new nómina looks needed.", "type": "boolean" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "nominaCreditosReconocidos": { "description": "Plazo of the nómina de créditos reconocidos.", "properties": { "approx": { "type": "boolean" }, "baseDate": { "format": "date-time", "type": "string" }, "baseEvent": { "type": "string" }, "businessDays": { "type": "boolean" }, "dayRule": { "enum": [ "corridos", "habiles_art7", "habiles_lunes_viernes" ], "type": "string" }, "dayRuleLabel": { "type": "string" }, "days": { "description": "Number of days.", "type": "integer" }, "daysLeft": { "type": "integer" }, "doneDate": { "format": "date-time", "type": "string" }, "doneEvent": { "type": "string" }, "dueDate": { "description": "Due date (ISO 8601).", "format": "date-time", "type": "string" }, "key": { "description": "Stable key.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "note": { "description": "Free-text note.", "type": "string" }, "status": { "description": "Current status.", "enum": [ "cumplido", "vencido", "vigente", "verificar" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "key", "title", "legalBasis", "note", "baseEvent", "baseDate", "dueDate", "days", "businessDays", "dayRule", "dayRuleLabel", "approx", "status", "daysLeft" ], "type": "object" }, "pendingBienesActa": { "description": "Unread documents of this kind; absent when the count failed.", "type": "integer" }, "pendingBienesOficios": { "description": "Unread documents of this kind; absent when the count failed.", "type": "integer" }, "pendingBienesRendiciones": { "description": "Unread documents of this kind; absent when the count failed.", "type": "integer" }, "pendingBienesSolicitud": { "description": "Unread documents of this kind; absent when the count failed.", "type": "integer" }, "pendingCompilado": { "description": "Unread documents of this kind; absent when the count failed.", "type": "integer" }, "pendingCreditos": { "description": "Unread documents of this kind; absent when the count failed.", "type": "integer" }, "pendingNomina": { "description": "Unread documents of this kind; absent when the count failed.", "type": "integer" }, "pendingObjeciones": { "description": "Unread documents of this kind; absent when the count failed.", "type": "integer" }, "pendingResoluciones": { "description": "Unread documents of this kind; absent when the count failed.", "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" } }, "required": [ "id", "rol", "nombre", "tipoProcedimiento", "familia", "necesitaAmpliacionONomina" ], "type": "object" }, "type": "array" }, "isSuperAdmin": { "type": "boolean" }, "issues": { "description": "Open extraction issues.", "items": { "properties": { "cbcId": { "type": "string" }, "failedAreas": { "items": { "type": "string" }, "type": "array" }, "identifier": { "description": "Issue tracker identifier.", "type": "string" }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": "string" }, "lastFailedAt": { "format": "date-time", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "cbcId", "rol", "identifier", "url", "status", "failedAreas", "lastError", "lastFailedAt" ], "type": "object" }, "type": "array" } }, "required": [ "causas", "issues", "canManage", "isSuperAdmin" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidador automation status", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-credits/queries/get-liquidator-credits-portfolio-status": { "post": { "description": "Get liquidator credits portfolio status\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-queries-get-liquidator-credits-portfolio-status", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "id": "string", "rol": "string", "nombre": "string", "tipoProcedimiento": "string", "familia": "string", "cierrePeriodoOrdinario": { "key": "string", "title": "string", "legalBasis": "string", "note": "string", "baseEvent": "string", "baseDate": "2026-01-31T12:00:00Z", "dueDate": "2026-01-31T12:00:00Z", "days": 0, "businessDays": true, "dayRule": "corridos", "dayRuleLabel": "string", "approx": true, "status": "cumplido", "doneEvent": "string", "doneDate": "2026-01-31T12:00:00Z", "daysLeft": 0 }, "nominaCreditosReconocidos": { "key": "string", "title": "string", "legalBasis": "string", "note": "string", "baseEvent": "string", "baseDate": "2026-01-31T12:00:00Z", "dueDate": "2026-01-31T12:00:00Z", "days": 0, "businessDays": true, "dayRule": "corridos", "dayRuleLabel": "string", "approx": true, "status": "cumplido", "doneEvent": "string", "doneDate": "2026-01-31T12:00:00Z", "daysLeft": 0 }, "necesitaAmpliacionONomina": true, "motivoAmpliacion": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causas": { "description": "PJUD causas.", "items": { "properties": { "cierrePeriodoOrdinario": { "description": "Plazo closing the ordinary verification period.", "properties": { "approx": { "type": "boolean" }, "baseDate": { "format": "date-time", "type": "string" }, "baseEvent": { "type": "string" }, "businessDays": { "type": "boolean" }, "dayRule": { "enum": [ "corridos", "habiles_art7", "habiles_lunes_viernes" ], "type": "string" }, "dayRuleLabel": { "type": "string" }, "days": { "description": "Number of days.", "type": "integer" }, "daysLeft": { "type": "integer" }, "doneDate": { "format": "date-time", "type": "string" }, "doneEvent": { "type": "string" }, "dueDate": { "description": "Due date (ISO 8601).", "format": "date-time", "type": "string" }, "key": { "description": "Stable key.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "note": { "description": "Free-text note.", "type": "string" }, "status": { "description": "Current status.", "enum": [ "cumplido", "vencido", "vigente", "verificar" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "key", "title", "legalBasis", "note", "baseEvent", "baseDate", "dueDate", "days", "businessDays", "dayRule", "dayRuleLabel", "approx", "status", "daysLeft" ], "type": "object" }, "familia": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "motivoAmpliacion": { "type": "string" }, "necesitaAmpliacionONomina": { "description": "Heuristic: an ampliación or new nómina looks needed.", "type": "boolean" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "nominaCreditosReconocidos": { "description": "Plazo of the nómina de créditos reconocidos.", "properties": { "approx": { "type": "boolean" }, "baseDate": { "format": "date-time", "type": "string" }, "baseEvent": { "type": "string" }, "businessDays": { "type": "boolean" }, "dayRule": { "enum": [ "corridos", "habiles_art7", "habiles_lunes_viernes" ], "type": "string" }, "dayRuleLabel": { "type": "string" }, "days": { "description": "Number of days.", "type": "integer" }, "daysLeft": { "type": "integer" }, "doneDate": { "format": "date-time", "type": "string" }, "doneEvent": { "type": "string" }, "dueDate": { "description": "Due date (ISO 8601).", "format": "date-time", "type": "string" }, "key": { "description": "Stable key.", "type": "string" }, "legalBasis": { "description": "Legal basis.", "type": "string" }, "note": { "description": "Free-text note.", "type": "string" }, "status": { "description": "Current status.", "enum": [ "cumplido", "vencido", "vigente", "verificar" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "key", "title", "legalBasis", "note", "baseEvent", "baseDate", "dueDate", "days", "businessDays", "dayRule", "dayRuleLabel", "approx", "status", "daysLeft" ], "type": "object" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" } }, "required": [ "id", "rol", "nombre", "tipoProcedimiento", "familia", "necesitaAmpliacionONomina" ], "type": "object" }, "type": "array" } }, "required": [ "causas" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidator credits portfolio status", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-credits/queries/get-liquidator-credits-summary": { "post": { "description": "Get liquidator credits summary\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-credits-queries-get-liquidator-credits-summary", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "canManage": true, "causa": { "id": "string", "rol": "string", "nombre": "string", "tribunal": "string", "source": "L", "documentId": "string", "causaId": "string", "tipoProcedimiento": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" }, "causa": { "properties": { "causaId": { "description": "Linked PJUD causa id.", "type": [ "string", "null" ] }, "documentId": { "description": "Boletín Concursal procedimiento document id.", "type": "string" }, "id": { "description": "Boletín Concursal procedimiento id.", "type": "string" }, "nombre": { "description": "Debtor name.", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "source": { "description": "L = liquidador's own portal account, P = public Boletín feed.", "enum": [ "L", "P" ], "type": "string" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] } }, "required": [ "id", "rol", "nombre", "tribunal", "source", "documentId", "causaId", "tipoProcedimiento" ], "type": "object" } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidator credits summary", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-writings/mutations/compile-liquidator-writing": { "post": { "description": "Compile liquidator writing\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-mutations-compile-liquidator-writing", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "2026-01-31T12:00:00Z", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "label": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "docPath": { "type": "string" }, "draftArtifactId": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": "string" }, "eventoId": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "selection": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "uploadJobId": { "type": "string" } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "label" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Compile liquidator writing", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-writings/mutations/complete-liquidator-writing-draft": { "post": { "description": "Complete liquidator writing draft\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-mutations-complete-liquidator-writing-draft", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "artifact": { "id": "string", "title": "string", "kind": "string", "state": "DRAFT", "body": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "contexto": "string", "sugerencia": "string", "opciones": [ { "tipo": "liquidador", "nombre": "string", "rut": "string", "patrocinaEnCausa": true, "ultimoUso": "string" } ], "permiteNuevo": true } ], "files": [ { "id": "string", "name": "string", "path": "string", "mimeType": "string" } ], "error": "string" }, "escrito": { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "2026-01-31T12:00:00Z", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "label": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "artifact": { "properties": { "body": { "description": "Draft text.", "type": "string" }, "error": { "description": "Export problem, empty when none.", "type": "string" }, "files": { "items": { "properties": { "id": { "description": "Artifact id plus \":docx\" or \":pdf\".", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Storage object path.", "type": "string" } }, "required": [ "id", "name", "path", "mimeType" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Draft kind, e.g. judicial or administrative.", "type": "string" }, "missingFields": { "description": "Data the draft still lacks.", "items": { "properties": { "clave": { "description": "Placeholder key.", "type": "string" }, "contexto": { "type": "string" }, "opciones": { "description": "Choices for a gap answered by picking one (the firma gap).", "items": { "properties": { "nombre": { "description": "Display name.", "type": "string" }, "patrocinaEnCausa": { "description": "The abogado already sponsors in this causa.", "type": "boolean" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "tipo": { "description": "Record type.", "enum": [ "liquidador", "abogado" ], "type": "string" }, "ultimoUso": { "description": "Last time the abogado appeared in the liquidador's escritos (YYYY-MM-DD).", "type": "string" } }, "required": [ "tipo" ], "type": "object" }, "type": "array" }, "permiteNuevo": { "description": "A new value may be entered besides the opciones.", "type": "boolean" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "sugerencia": { "description": "Suggested value.", "type": "string" } }, "required": [ "clave", "pregunta" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state.", "enum": [ "DRAFT", "EXPORT_PENDING" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "kind", "state", "body", "missingFields", "files", "error" ], "type": "object" }, "escrito": { "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "docPath": { "type": "string" }, "draftArtifactId": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": "string" }, "eventoId": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "selection": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "uploadJobId": { "type": "string" } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "label" ], "type": "object" } }, "required": [ "artifact", "escrito" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Complete liquidator writing draft", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-writings/mutations/detect-liquidator-writings": { "post": { "description": "Detect liquidator writings\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-mutations-detect-liquidator-writings", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "created": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "created": { "type": "integer" } }, "required": [ "created" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Detect liquidator writings", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-writings/mutations/dismiss-liquidator-writing": { "post": { "description": "Dismiss liquidator writing\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-mutations-dismiss-liquidator-writing", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "2026-01-31T12:00:00Z", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "label": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "docPath": { "type": "string" }, "draftArtifactId": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": "string" }, "eventoId": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "selection": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "uploadJobId": { "type": "string" } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "label" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Dismiss liquidator writing", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-writings/mutations/generate-liquidator-writing-draft": { "post": { "description": "Generate liquidator writing draft\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-mutations-generate-liquidator-writing-draft", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "queued": true, "alreadyRunning": true, "escrito": { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "2026-01-31T12:00:00Z", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "label": "string", "generating": true } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "alreadyRunning": { "type": "boolean" }, "escrito": { "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "docPath": { "type": "string" }, "draftArtifactId": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": "string" }, "eventoId": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "generating": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "selection": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "uploadJobId": { "type": "string" } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "label" ], "type": "object" }, "queued": { "type": "boolean" } }, "required": [ "queued", "alreadyRunning", "escrito" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Generate liquidator writing draft", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-writings/mutations/publish-liquidator-writing": { "post": { "description": "Publish liquidator writing\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-mutations-publish-liquidator-writing", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "jobId": "string", "escrito": { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "2026-01-31T12:00:00Z", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "label": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "escrito": { "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "docPath": { "type": "string" }, "draftArtifactId": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": "string" }, "eventoId": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "selection": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "uploadJobId": { "type": "string" } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "label" ], "type": "object" }, "jobId": { "description": "Background job id.", "type": "string" } }, "required": [ "jobId", "escrito" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Publish liquidator writing", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-writings/mutations/publish-primera-publicacion": { "post": { "description": "Publish primera publicacion\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-mutations-publish-primera-publicacion", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "resolucionJobId": "string", "antecedentesJobId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "antecedentesJobId": { "type": "string" }, "resolucionJobId": { "type": "string" } }, "required": [ "resolucionJobId", "antecedentesJobId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Publish primera publicacion", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-writings/mutations/save-liquidator-writing-draft-text": { "post": { "description": "Save liquidator writing draft text\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-mutations-save-liquidator-writing-draft-text", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "artifact": { "id": "string", "title": "string", "kind": "string", "state": "DRAFT", "body": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "contexto": "string", "sugerencia": "string", "opciones": [ { "tipo": "liquidador", "nombre": "string", "rut": "string", "patrocinaEnCausa": true, "ultimoUso": "string" } ], "permiteNuevo": true } ], "files": [ { "id": "string", "name": "string", "path": "string", "mimeType": "string" } ], "error": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "artifact": { "properties": { "body": { "description": "Draft text.", "type": "string" }, "error": { "description": "Export problem, empty when none.", "type": "string" }, "files": { "items": { "properties": { "id": { "description": "Artifact id plus \":docx\" or \":pdf\".", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Storage object path.", "type": "string" } }, "required": [ "id", "name", "path", "mimeType" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Draft kind, e.g. judicial or administrative.", "type": "string" }, "missingFields": { "description": "Data the draft still lacks.", "items": { "properties": { "clave": { "description": "Placeholder key.", "type": "string" }, "contexto": { "type": "string" }, "opciones": { "description": "Choices for a gap answered by picking one (the firma gap).", "items": { "properties": { "nombre": { "description": "Display name.", "type": "string" }, "patrocinaEnCausa": { "description": "The abogado already sponsors in this causa.", "type": "boolean" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "tipo": { "description": "Record type.", "enum": [ "liquidador", "abogado" ], "type": "string" }, "ultimoUso": { "description": "Last time the abogado appeared in the liquidador's escritos (YYYY-MM-DD).", "type": "string" } }, "required": [ "tipo" ], "type": "object" }, "type": "array" }, "permiteNuevo": { "description": "A new value may be entered besides the opciones.", "type": "boolean" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "sugerencia": { "description": "Suggested value.", "type": "string" } }, "required": [ "clave", "pregunta" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state.", "enum": [ "DRAFT", "EXPORT_PENDING" ], "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "kind", "state", "body", "missingFields", "files", "error" ], "type": "object" } }, "required": [ "artifact" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save liquidator writing draft text", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-writings/mutations/update-liquidator-writing-selection": { "post": { "description": "Update liquidator writing selection\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-mutations-update-liquidator-writing-selection", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "2026-01-31T12:00:00Z", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "label": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "docPath": { "type": "string" }, "draftArtifactId": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": "string" }, "eventoId": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "selection": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "uploadJobId": { "type": "string" } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "label" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update liquidator writing selection", "tags": [ "Documents and Drive" ], "x-modifies-data": true, "x-required-scope": "liquidaciones:write" } }, "/api/actions/liquidator-writings/queries/get-liquidator-writing-document-url": { "post": { "description": "Get liquidator writing document url\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-queries-get-liquidator-writing-document-url", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "previewUrl": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "previewUrl": { "description": "Short-lived URL to preview the file.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidator writing document url", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-writings/queries/get-liquidator-writing-draft-text": { "post": { "description": "Get liquidator writing draft text\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-queries-get-liquidator-writing-draft-text", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "body": "string", "missingFields": [ "string" ], "escrito": { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "2026-01-31T12:00:00Z", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "label": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "body": { "description": "Message text.", "type": "string" }, "escrito": { "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "docPath": { "type": "string" }, "draftArtifactId": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": "string" }, "eventoId": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "selection": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "uploadJobId": { "type": "string" } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "label" ], "type": "object" }, "missingFields": { "items": { "type": "string" }, "type": "array" } }, "required": [ "body", "missingFields", "escrito" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidator writing draft text", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-writings/queries/get-liquidator-writing-folios": { "post": { "description": "Get liquidator writing folios\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-queries-get-liquidator-writing-folios", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "folios": [ { "id": "string", "folio": "string", "tramite": "string", "descripcion": "string", "fecha": "2026-01-31T12:00:00Z", "hasDoc": true, "docPath": "string", "selected": true, "isResolucion": true } ], "escrito": { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "2026-01-31T12:00:00Z", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "label": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "escrito": { "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "docPath": { "type": "string" }, "draftArtifactId": { "type": "string" }, "dueAt": { "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": "string" }, "eventoId": { "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "publicationType": { "description": "Publication type.", "type": "string" }, "selection": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "Current state.", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" }, "uploadJobId": { "type": "string" } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "label" ], "type": "object" }, "folios": { "items": { "properties": { "descripcion": { "type": "string" }, "docPath": { "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "folio": { "description": "Folio number in the court file.", "type": "string" }, "hasDoc": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "isResolucion": { "type": "boolean" }, "selected": { "type": "boolean" }, "tramite": { "description": "Procedural step.", "type": "string" } }, "required": [ "id", "folio", "tramite", "descripcion", "fecha", "hasDoc", "docPath", "selected", "isResolucion" ], "type": "object" }, "type": "array" } }, "required": [ "folios" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get liquidator writing folios", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/liquidator-writings/queries/list-liquidator-writings": { "post": { "description": "List liquidator writings\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-liquidator-writings-queries-list-liquidator-writings", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "escritos": [ { "id": "string", "causaBcId": "string", "causaId": "string", "eventoId": "string", "tipo": "string", "state": "string", "dueAt": "string", "taskId": "string", "draftArtifactId": "string", "docPath": "string", "fileName": "string", "selection": [ "string" ], "publicationType": "string", "uploadJobId": "string", "error": "string", "createdAt": "string", "updatedAt": "string", "rol": "string", "nombre": "string", "tribunal": "string", "eventoFecha": "string", "eventoDetectedAt": "string", "eventoPayload": {}, "jobState": "string", "jobError": "string", "portalPubId": "string", "taskStatus": "string", "taskDueDate": "string", "draftFiles": [ { "id": "string", "name": "string", "path": "string", "mimeType": "string" } ], "draftState": "string", "draftMissingFields": [ { "clave": "string", "pregunta": "string", "contexto": "string", "sugerencia": "string", "opciones": [ { "tipo": "liquidador", "nombre": "string", "rut": "string", "patrocinaEnCausa": true, "ultimoUso": "string" } ], "permiteNuevo": true } ], "generating": true, "compiled": true, "drafted": true, "filingChannels": [ "string" ], "filings": { "\u003ckey\u003e": { "canal": "string", "jobId": "string", "state": "string", "status": "string", "error": "string", "folio": "string", "numeroIngreso": "string" } }, "label": "string", "labelEn": "string", "pjudFilingEnabled": true, "publishes": true } ], "counts": { "\u003ckey\u003e": 0 }, "tipoCounts": { "\u003ckey\u003e": 0 }, "limit": 0, "catalog": [ { "tipo": "string", "label": "string", "labelEn": "string", "publishes": true, "drafted": true, "compiled": true } ], "canManage": true, "pjudFilingEnabled": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" }, "catalog": { "items": { "properties": { "compiled": { "type": "boolean" }, "drafted": { "type": "boolean" }, "label": { "description": "Human-readable label.", "type": "string" }, "labelEn": { "type": "string" }, "publishes": { "type": "boolean" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "tipo", "label", "labelEn", "publishes", "drafted", "compiled" ], "type": "object" }, "type": "array" }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Escritos per state.", "type": "object" }, "escritos": { "items": { "properties": { "causaBcId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "compiled": { "type": "boolean" }, "createdAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "docPath": { "type": [ "string", "null" ] }, "draftArtifactId": { "description": "LiquidacionDraftArtifact produced for AI-drafted escritos.", "type": [ "string", "null" ] }, "draftFiles": { "items": { "properties": { "id": { "description": "Artifact id plus \":docx\" or \":pdf\".", "type": "string" }, "mimeType": { "description": "MIME type.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "path": { "description": "Storage object path.", "type": "string" } }, "required": [ "id", "name", "path", "mimeType" ], "type": "object" }, "type": [ "array", "null" ] }, "draftMissingFields": { "items": { "properties": { "clave": { "description": "Placeholder key.", "type": "string" }, "contexto": { "type": "string" }, "opciones": { "description": "Choices for a gap answered by picking one (the firma gap).", "items": { "properties": { "nombre": { "description": "Display name.", "type": "string" }, "patrocinaEnCausa": { "description": "The abogado already sponsors in this causa.", "type": "boolean" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "tipo": { "description": "Record type.", "enum": [ "liquidador", "abogado" ], "type": "string" }, "ultimoUso": { "description": "Last time the abogado appeared in the liquidador's escritos (YYYY-MM-DD).", "type": "string" } }, "required": [ "tipo" ], "type": "object" }, "type": "array" }, "permiteNuevo": { "description": "A new value may be entered besides the opciones.", "type": "boolean" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "sugerencia": { "description": "Suggested value.", "type": "string" } }, "required": [ "clave", "pregunta" ], "type": "object" }, "type": [ "array", "null" ] }, "draftState": { "type": [ "string", "null" ] }, "drafted": { "type": "boolean" }, "dueAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "eventoDetectedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "eventoFecha": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "eventoId": { "type": [ "string", "null" ] }, "eventoPayload": { "description": "Payload of the detected evento that proposed the escrito; its fields depend on the evento kind." }, "fileName": { "description": "Original file name.", "type": [ "string", "null" ] }, "filingChannels": { "description": "Channels the escrito can be filed through (bc, pjud).", "items": { "type": "string" }, "type": "array" }, "filings": { "additionalProperties": { "properties": { "canal": { "type": "string" }, "error": { "type": [ "string", "null" ] }, "folio": { "description": "Folio number in the court file.", "type": [ "string", "null" ] }, "jobId": { "description": "Background job id.", "type": [ "string", "null" ] }, "numeroIngreso": { "type": [ "string", "null" ] }, "state": { "description": "Current state.", "type": "string" }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "canal", "jobId", "state", "status", "error" ], "type": "object" }, "description": "Latest filing job per channel, keyed by channel.", "type": "object" }, "generating": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "jobError": { "type": [ "string", "null" ] }, "jobState": { "type": [ "string", "null" ] }, "label": { "description": "Human-readable label.", "type": "string" }, "labelEn": { "type": "string" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "pjudFilingEnabled": { "type": "boolean" }, "portalPubId": { "type": [ "string", "null" ] }, "publicationType": { "description": "Publication type.", "type": "string" }, "publishes": { "description": "The tipo is published to the Boletín.", "type": "boolean" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "selection": { "description": "Ids of the movements or documents selected for a compiled escrito.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "state": { "description": "Current state.", "type": "string" }, "taskDueDate": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": [ "string", "null" ] }, "taskId": { "description": "Task id.", "type": [ "string", "null" ] }, "taskStatus": { "type": [ "string", "null" ] }, "tipo": { "description": "Record type.", "type": "string" }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "updatedAt": { "description": "Timestamp as rendered by Postgres JSON: ISO 8601 without a zone offset.", "type": "string" }, "uploadJobId": { "type": [ "string", "null" ] } }, "required": [ "id", "causaBcId", "causaId", "eventoId", "tipo", "state", "dueAt", "taskId", "draftArtifactId", "docPath", "fileName", "selection", "publicationType", "uploadJobId", "error", "createdAt", "updatedAt", "rol", "nombre", "tribunal", "eventoFecha", "eventoDetectedAt", "eventoPayload", "jobState", "jobError", "portalPubId", "taskStatus", "taskDueDate", "draftFiles", "draftState", "draftMissingFields", "generating", "compiled", "drafted", "filingChannels", "filings", "label", "labelEn", "pjudFilingEnabled", "publishes" ], "type": "object" }, "type": "array" }, "limit": { "type": "integer" }, "pjudFilingEnabled": { "type": "boolean" }, "tipoCounts": { "additionalProperties": { "type": "integer" }, "description": "Open escritos per tipo.", "type": "object" } }, "required": [ "escritos", "counts", "tipoCounts", "limit", "catalog", "canManage", "pjudFilingEnabled" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"liquidaciones:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"liquidaciones:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "liquidaciones:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List liquidator writings", "tags": [ "Documents and Drive" ], "x-required-scope": "liquidaciones:read" } }, "/api/actions/meetings/mutations/cancel-meeting": { "post": { "description": "Cancel meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-mutations-cancel-meeting", "requestBody": { "content": { "application/json": { "example": { "args": [ { "meetingId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "meetingId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "meetingId": "string", "state": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "meetingId": { "description": "Meeting id.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "meetingId", "state" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Cancel meeting", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/meetings/mutations/create-meeting": { "post": { "description": "Create meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-mutations-create-meeting", "requestBody": { "content": { "application/json": { "example": { "args": [ { "allowGuests": false, "conversationId": "", "description": "", "durationMin": 0, "inviteEmails": [], "inviteUserIds": [], "lobbyEnabled": false, "meetingId": "", "recordingEnabled": false, "scheduledAt": "", "title": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "allowGuests": { "type": "boolean" }, "conversationId": { "type": "string" }, "description": { "type": "string" }, "durationMin": { "type": "number" }, "inviteEmails": { "items": { "type": "string" }, "type": "array" }, "inviteUserIds": { "items": { "type": "string" }, "type": "array" }, "lobbyEnabled": { "type": "boolean" }, "meetingId": { "type": "string" }, "recordingEnabled": { "type": "boolean" }, "scheduledAt": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "meeting": { "id": "string", "title": "string", "description": "string", "hostId": "string", "conversationId": "string", "timezone": "string", "roomName": "string", "joinCode": "string", "state": "string", "scheduledAt": "2026-01-31T12:00:00Z", "lockedAt": "2026-01-31T12:00:00Z", "durationMin": 0, "lobbyEnabled": true, "allowGuests": true, "recordingEnabled": true, "admittedIdentities": [ "string" ], "createdAt": "2026-01-31T12:00:00Z", "joinPath": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "meeting": { "description": "The meeting.", "properties": { "admittedIdentities": { "description": "Guests admitted from the lobby.", "items": { "type": "string" }, "type": "array" }, "allowGuests": { "description": "Whether people without an account may join.", "type": "boolean" }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "durationMin": { "description": "Duration in minutes.", "type": "integer" }, "hostId": { "description": "Id of the meeting host.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "joinCode": { "description": "Code guests use to join.", "type": "string" }, "joinPath": { "description": "Path of the join page.", "type": "string" }, "lobbyEnabled": { "description": "Whether guests wait in a lobby until admitted.", "type": "boolean" }, "lockedAt": { "description": "When it was locked (ISO 8601); null when unlocked.", "format": "date-time", "type": [ "string", "null" ] }, "recordingEnabled": { "description": "Whether the meeting is recorded.", "type": "boolean" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "scheduledAt": { "description": "Scheduled start (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "type": "string" }, "timezone": { "description": "IANA time zone, e.g. America/Santiago.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "description", "hostId", "conversationId", "timezone", "roomName", "joinCode", "state", "scheduledAt", "lockedAt", "durationMin", "lobbyEnabled", "allowGuests", "recordingEnabled", "admittedIdentities", "createdAt", "joinPath" ], "type": [ "object", "null" ] } }, "required": [ "meeting" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create meeting", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/meetings/mutations/join-meeting": { "post": { "description": "Join meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-mutations-join-meeting", "requestBody": { "content": { "application/json": { "example": { "args": [ { "joinCode": "", "meetingId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "joinCode": { "type": "string" }, "meetingId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "token": "string", "roomName": "string", "identity": "string", "role": "string", "call": { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "string", "state": "string", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0 }, "meeting": { "id": "string", "title": "string", "description": "string", "hostId": "string", "conversationId": "string", "timezone": "string", "roomName": "string", "joinCode": "string", "state": "string", "scheduledAt": "2026-01-31T12:00:00Z", "lockedAt": "2026-01-31T12:00:00Z", "durationMin": 0, "lobbyEnabled": true, "allowGuests": true, "recordingEnabled": true, "admittedIdentities": [ "string" ], "createdAt": "2026-01-31T12:00:00Z", "joinPath": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "call": { "description": "The call.", "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endReason": { "description": "Why the call ended.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": [ "object", "null" ] }, "identity": { "description": "Participant identity.", "type": "string" }, "meeting": { "description": "The meeting.", "properties": { "admittedIdentities": { "description": "Guests admitted from the lobby.", "items": { "type": "string" }, "type": "array" }, "allowGuests": { "description": "Whether people without an account may join.", "type": "boolean" }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "durationMin": { "description": "Duration in minutes.", "type": "integer" }, "hostId": { "description": "Id of the meeting host.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "joinCode": { "description": "Code guests use to join.", "type": "string" }, "joinPath": { "description": "Path of the join page.", "type": "string" }, "lobbyEnabled": { "description": "Whether guests wait in a lobby until admitted.", "type": "boolean" }, "lockedAt": { "description": "When it was locked (ISO 8601); null when unlocked.", "format": "date-time", "type": [ "string", "null" ] }, "recordingEnabled": { "description": "Whether the meeting is recorded.", "type": "boolean" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "scheduledAt": { "description": "Scheduled start (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "type": "string" }, "timezone": { "description": "IANA time zone, e.g. America/Santiago.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "description", "hostId", "conversationId", "timezone", "roomName", "joinCode", "state", "scheduledAt", "lockedAt", "durationMin", "lobbyEnabled", "allowGuests", "recordingEnabled", "admittedIdentities", "createdAt", "joinPath" ], "type": [ "object", "null" ] }, "role": { "description": "Role.", "type": "string" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "token": { "description": "Opaque token.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url", "token", "roomName", "identity", "role", "call", "meeting" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Join meeting", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/meetings/mutations/meeting-host-action": { "post": { "description": "Meeting host action\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-mutations-meeting-host-action", "requestBody": { "content": { "application/json": { "example": { "args": [ { "identity": "", "meetingId": "", "op": "", "trackSid": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "identity": { "type": "string" }, "meetingId": { "type": "string" }, "op": { "type": "string" }, "trackSid": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "meeting": { "id": "string", "title": "string", "description": "string", "hostId": "string", "conversationId": "string", "timezone": "string", "roomName": "string", "joinCode": "string", "state": "SCHEDULED", "scheduledAt": "2026-01-31T12:00:00Z", "lockedAt": "2026-01-31T12:00:00Z", "durationMin": 0, "lobbyEnabled": true, "allowGuests": true, "recordingEnabled": true, "admittedIdentities": [ "string" ], "createdAt": "2026-01-31T12:00:00Z", "joinPath": "string" }, "hostName": "string", "call": { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "AUDIO", "state": "RINGING", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0 }, "participants": [ { "userId": "string", "name": "string", "identity": "string", "role": "HOST", "state": "string", "joinedAt": "2026-01-31T12:00:00Z", "leftAt": "2026-01-31T12:00:00Z", "guest": true } ], "waiting": [ { "userId": "string", "name": "string", "identity": "string", "role": "HOST", "state": "string", "joinedAt": "2026-01-31T12:00:00Z", "leftAt": "2026-01-31T12:00:00Z", "guest": true } ], "invites": [ { "userId": "string", "email": "string", "name": "string", "state": "PENDING", "sentAt": "2026-01-31T12:00:00Z" } ], "recordings": [ { "id": "string", "meetingId": "string", "callId": "string", "startedById": "string", "bytes": 0, "durationMs": 0, "state": "RECORDING", "error": "string", "startedAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "expiresAt": "2026-01-31T12:00:00Z", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "call": { "description": "The live call; absent when the meeting is not in progress.", "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat the call belongs to; empty for meeting calls.", "type": "string" }, "durationMs": { "description": "Only once ended.", "type": "integer" }, "endReason": { "description": "hangup, missed, declined, room_finished, host_ended or error; empty while live.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "enum": [ "AUDIO", "VIDEO" ], "type": "string" }, "meetingId": { "description": "Meeting the call belongs to; empty for chat calls.", "type": "string" }, "roomName": { "description": "LiveKit room.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "enum": [ "RINGING", "ACTIVE", "ENDED", "MISSED", "DECLINED" ], "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": "object" }, "hostName": { "type": "string" }, "invites": { "items": { "properties": { "email": { "description": "Email address.", "type": [ "string", "null" ] }, "name": { "description": "Display name.", "type": "string" }, "sentAt": { "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "enum": [ "PENDING", "ACCEPTED", "DECLINED" ], "type": "string" }, "userId": { "description": "Invited org user; null for an external email.", "type": [ "string", "null" ] } }, "required": [ "userId", "email", "name", "state", "sentAt" ], "type": "object" }, "type": "array" }, "meeting": { "description": "The meeting.", "properties": { "admittedIdentities": { "description": "LiveKit identities admitted from the lobby.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "allowGuests": { "description": "Whether people without an account may join.", "type": "boolean" }, "conversationId": { "description": "Chat the meeting was created from; empty when none.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "durationMin": { "description": "Duration in minutes.", "type": "integer" }, "hostId": { "description": "Id of the meeting host.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "joinCode": { "description": "Code guests use to join.", "type": "string" }, "joinPath": { "description": "Relative join link (/meet/\u003cjoinCode\u003e).", "type": "string" }, "lobbyEnabled": { "description": "Whether guests wait in a lobby until admitted.", "type": "boolean" }, "lockedAt": { "description": "Set while the host keeps the room locked.", "format": "date-time", "type": [ "string", "null" ] }, "recordingEnabled": { "description": "Whether the meeting is recorded.", "type": "boolean" }, "roomName": { "description": "LiveKit room.", "type": "string" }, "scheduledAt": { "description": "Scheduled start (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "enum": [ "SCHEDULED", "LIVE", "ENDED", "CANCELLED" ], "type": "string" }, "timezone": { "description": "IANA time zone, e.g. America/Santiago.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "description", "hostId", "conversationId", "timezone", "roomName", "joinCode", "state", "scheduledAt", "lockedAt", "durationMin", "lobbyEnabled", "allowGuests", "recordingEnabled", "admittedIdentities", "createdAt", "joinPath" ], "type": "object" }, "participants": { "description": "Participants in the room (live call only).", "items": { "properties": { "guest": { "type": "boolean" }, "identity": { "description": "LiveKit participant identity.", "type": "string" }, "joinedAt": { "format": "date-time", "type": [ "string", "null" ] }, "leftAt": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "User name, or the guest's name.", "type": "string" }, "role": { "description": "Role.", "enum": [ "HOST", "PARTICIPANT", "GUEST" ], "type": "string" }, "state": { "description": "Participant state (INVITED, WAITING, JOINED, LEFT, DECLINED).", "type": "string" }, "userId": { "description": "Empty for a guest.", "type": "string" } }, "required": [ "userId", "name", "identity", "role", "state", "joinedAt", "leftAt", "guest" ], "type": "object" }, "type": "array" }, "recordings": { "description": "The meeting's recordings, newest first.", "items": { "properties": { "bytes": { "description": "Size in bytes.", "type": "integer" }, "callId": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "expiresAt": { "description": "When retention deletes it.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "enum": [ "RECORDING", "READY", "FAILED" ], "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "meetingId", "callId", "startedById", "bytes", "durationMs", "state", "error", "startedAt", "endedAt", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "waiting": { "description": "Participants waiting in the lobby (live call only).", "items": { "properties": { "guest": { "type": "boolean" }, "identity": { "description": "LiveKit participant identity.", "type": "string" }, "joinedAt": { "format": "date-time", "type": [ "string", "null" ] }, "leftAt": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "User name, or the guest's name.", "type": "string" }, "role": { "description": "Role.", "enum": [ "HOST", "PARTICIPANT", "GUEST" ], "type": "string" }, "state": { "description": "Participant state (INVITED, WAITING, JOINED, LEFT, DECLINED).", "type": "string" }, "userId": { "description": "Empty for a guest.", "type": "string" } }, "required": [ "userId", "name", "identity", "role", "state", "joinedAt", "leftAt", "guest" ], "type": "object" }, "type": "array" } }, "required": [ "meeting", "hostName", "invites", "recordings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Meeting host action", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/meetings/mutations/meeting-recording": { "post": { "description": "Meeting recording\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-mutations-meeting-recording", "requestBody": { "content": { "application/json": { "example": { "args": [ { "audioOnly": false, "meetingId": "", "op": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "audioOnly": { "type": "boolean" }, "meetingId": { "type": "string" }, "op": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "meeting": { "id": "string", "title": "string", "description": "string", "hostId": "string", "conversationId": "string", "timezone": "string", "roomName": "string", "joinCode": "string", "state": "SCHEDULED", "scheduledAt": "2026-01-31T12:00:00Z", "lockedAt": "2026-01-31T12:00:00Z", "durationMin": 0, "lobbyEnabled": true, "allowGuests": true, "recordingEnabled": true, "admittedIdentities": [ "string" ], "createdAt": "2026-01-31T12:00:00Z", "joinPath": "string" }, "hostName": "string", "call": { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "AUDIO", "state": "RINGING", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0 }, "participants": [ { "userId": "string", "name": "string", "identity": "string", "role": "HOST", "state": "string", "joinedAt": "2026-01-31T12:00:00Z", "leftAt": "2026-01-31T12:00:00Z", "guest": true } ], "waiting": [ { "userId": "string", "name": "string", "identity": "string", "role": "HOST", "state": "string", "joinedAt": "2026-01-31T12:00:00Z", "leftAt": "2026-01-31T12:00:00Z", "guest": true } ], "invites": [ { "userId": "string", "email": "string", "name": "string", "state": "PENDING", "sentAt": "2026-01-31T12:00:00Z" } ], "recordings": [ { "id": "string", "meetingId": "string", "callId": "string", "startedById": "string", "bytes": 0, "durationMs": 0, "state": "RECORDING", "error": "string", "startedAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "expiresAt": "2026-01-31T12:00:00Z", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "call": { "description": "The live call; absent when the meeting is not in progress.", "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat the call belongs to; empty for meeting calls.", "type": "string" }, "durationMs": { "description": "Only once ended.", "type": "integer" }, "endReason": { "description": "hangup, missed, declined, room_finished, host_ended or error; empty while live.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "enum": [ "AUDIO", "VIDEO" ], "type": "string" }, "meetingId": { "description": "Meeting the call belongs to; empty for chat calls.", "type": "string" }, "roomName": { "description": "LiveKit room.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "enum": [ "RINGING", "ACTIVE", "ENDED", "MISSED", "DECLINED" ], "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": "object" }, "hostName": { "type": "string" }, "invites": { "items": { "properties": { "email": { "description": "Email address.", "type": [ "string", "null" ] }, "name": { "description": "Display name.", "type": "string" }, "sentAt": { "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "enum": [ "PENDING", "ACCEPTED", "DECLINED" ], "type": "string" }, "userId": { "description": "Invited org user; null for an external email.", "type": [ "string", "null" ] } }, "required": [ "userId", "email", "name", "state", "sentAt" ], "type": "object" }, "type": "array" }, "meeting": { "description": "The meeting.", "properties": { "admittedIdentities": { "description": "LiveKit identities admitted from the lobby.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "allowGuests": { "description": "Whether people without an account may join.", "type": "boolean" }, "conversationId": { "description": "Chat the meeting was created from; empty when none.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "durationMin": { "description": "Duration in minutes.", "type": "integer" }, "hostId": { "description": "Id of the meeting host.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "joinCode": { "description": "Code guests use to join.", "type": "string" }, "joinPath": { "description": "Relative join link (/meet/\u003cjoinCode\u003e).", "type": "string" }, "lobbyEnabled": { "description": "Whether guests wait in a lobby until admitted.", "type": "boolean" }, "lockedAt": { "description": "Set while the host keeps the room locked.", "format": "date-time", "type": [ "string", "null" ] }, "recordingEnabled": { "description": "Whether the meeting is recorded.", "type": "boolean" }, "roomName": { "description": "LiveKit room.", "type": "string" }, "scheduledAt": { "description": "Scheduled start (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "enum": [ "SCHEDULED", "LIVE", "ENDED", "CANCELLED" ], "type": "string" }, "timezone": { "description": "IANA time zone, e.g. America/Santiago.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "description", "hostId", "conversationId", "timezone", "roomName", "joinCode", "state", "scheduledAt", "lockedAt", "durationMin", "lobbyEnabled", "allowGuests", "recordingEnabled", "admittedIdentities", "createdAt", "joinPath" ], "type": "object" }, "participants": { "description": "Participants in the room (live call only).", "items": { "properties": { "guest": { "type": "boolean" }, "identity": { "description": "LiveKit participant identity.", "type": "string" }, "joinedAt": { "format": "date-time", "type": [ "string", "null" ] }, "leftAt": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "User name, or the guest's name.", "type": "string" }, "role": { "description": "Role.", "enum": [ "HOST", "PARTICIPANT", "GUEST" ], "type": "string" }, "state": { "description": "Participant state (INVITED, WAITING, JOINED, LEFT, DECLINED).", "type": "string" }, "userId": { "description": "Empty for a guest.", "type": "string" } }, "required": [ "userId", "name", "identity", "role", "state", "joinedAt", "leftAt", "guest" ], "type": "object" }, "type": "array" }, "recordings": { "description": "The meeting's recordings, newest first.", "items": { "properties": { "bytes": { "description": "Size in bytes.", "type": "integer" }, "callId": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "expiresAt": { "description": "When retention deletes it.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "enum": [ "RECORDING", "READY", "FAILED" ], "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "meetingId", "callId", "startedById", "bytes", "durationMs", "state", "error", "startedAt", "endedAt", "expiresAt", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "waiting": { "description": "Participants waiting in the lobby (live call only).", "items": { "properties": { "guest": { "type": "boolean" }, "identity": { "description": "LiveKit participant identity.", "type": "string" }, "joinedAt": { "format": "date-time", "type": [ "string", "null" ] }, "leftAt": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "User name, or the guest's name.", "type": "string" }, "role": { "description": "Role.", "enum": [ "HOST", "PARTICIPANT", "GUEST" ], "type": "string" }, "state": { "description": "Participant state (INVITED, WAITING, JOINED, LEFT, DECLINED).", "type": "string" }, "userId": { "description": "Empty for a guest.", "type": "string" } }, "required": [ "userId", "name", "identity", "role", "state", "joinedAt", "leftAt", "guest" ], "type": "object" }, "type": "array" } }, "required": [ "meeting", "hostName", "invites", "recordings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Meeting recording", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/meetings/mutations/start-meeting": { "post": { "description": "Start meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-mutations-start-meeting", "requestBody": { "content": { "application/json": { "example": { "args": [ { "meetingId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "meetingId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "token": "string", "roomName": "string", "identity": "string", "role": "string", "call": { "id": "string", "conversationId": "string", "meetingId": "string", "roomName": "string", "kind": "string", "state": "string", "startedById": "string", "startedAt": "2026-01-31T12:00:00Z", "answeredAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "endReason": "string", "durationMs": 0 }, "meeting": { "id": "string", "title": "string", "description": "string", "hostId": "string", "conversationId": "string", "timezone": "string", "roomName": "string", "joinCode": "string", "state": "string", "scheduledAt": "2026-01-31T12:00:00Z", "lockedAt": "2026-01-31T12:00:00Z", "durationMin": 0, "lobbyEnabled": true, "allowGuests": true, "recordingEnabled": true, "admittedIdentities": [ "string" ], "createdAt": "2026-01-31T12:00:00Z", "joinPath": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "call": { "description": "The call.", "properties": { "answeredAt": { "description": "When the call was answered (ISO 8601); null if never answered.", "format": "date-time", "type": [ "string", "null" ] }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "durationMs": { "description": "Duration in milliseconds.", "type": "integer" }, "endReason": { "description": "Why the call ended.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "meetingId": { "description": "Meeting id.", "type": "string" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "startedById": { "description": "Id of the user who started it.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "id", "conversationId", "meetingId", "roomName", "kind", "state", "startedById", "startedAt", "answeredAt", "endedAt", "endReason" ], "type": [ "object", "null" ] }, "identity": { "description": "Participant identity.", "type": "string" }, "meeting": { "description": "The meeting.", "properties": { "admittedIdentities": { "description": "Guests admitted from the lobby.", "items": { "type": "string" }, "type": "array" }, "allowGuests": { "description": "Whether people without an account may join.", "type": "boolean" }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "durationMin": { "description": "Duration in minutes.", "type": "integer" }, "hostId": { "description": "Id of the meeting host.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "joinCode": { "description": "Code guests use to join.", "type": "string" }, "joinPath": { "description": "Path of the join page.", "type": "string" }, "lobbyEnabled": { "description": "Whether guests wait in a lobby until admitted.", "type": "boolean" }, "lockedAt": { "description": "When it was locked (ISO 8601); null when unlocked.", "format": "date-time", "type": [ "string", "null" ] }, "recordingEnabled": { "description": "Whether the meeting is recorded.", "type": "boolean" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "scheduledAt": { "description": "Scheduled start (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "type": "string" }, "timezone": { "description": "IANA time zone, e.g. America/Santiago.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "description", "hostId", "conversationId", "timezone", "roomName", "joinCode", "state", "scheduledAt", "lockedAt", "durationMin", "lobbyEnabled", "allowGuests", "recordingEnabled", "admittedIdentities", "createdAt", "joinPath" ], "type": [ "object", "null" ] }, "role": { "description": "Role.", "type": "string" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "token": { "description": "Opaque token.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url", "token", "roomName", "identity", "role", "call", "meeting" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start meeting", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/meetings/mutations/update-meeting": { "post": { "description": "Update meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-mutations-update-meeting", "requestBody": { "content": { "application/json": { "example": { "args": [ { "allowGuests": false, "conversationId": "", "description": "", "durationMin": 0, "inviteEmails": [], "inviteUserIds": [], "lobbyEnabled": false, "meetingId": "", "recordingEnabled": false, "scheduledAt": "", "title": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "allowGuests": { "type": "boolean" }, "conversationId": { "type": "string" }, "description": { "type": "string" }, "durationMin": { "type": "number" }, "inviteEmails": { "items": { "type": "string" }, "type": "array" }, "inviteUserIds": { "items": { "type": "string" }, "type": "array" }, "lobbyEnabled": { "type": "boolean" }, "meetingId": { "type": "string" }, "recordingEnabled": { "type": "boolean" }, "scheduledAt": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "meeting": { "id": "string", "title": "string", "description": "string", "hostId": "string", "conversationId": "string", "timezone": "string", "roomName": "string", "joinCode": "string", "state": "string", "scheduledAt": "2026-01-31T12:00:00Z", "lockedAt": "2026-01-31T12:00:00Z", "durationMin": 0, "lobbyEnabled": true, "allowGuests": true, "recordingEnabled": true, "admittedIdentities": [ "string" ], "createdAt": "2026-01-31T12:00:00Z", "joinPath": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "meeting": { "description": "The meeting.", "properties": { "admittedIdentities": { "description": "Guests admitted from the lobby.", "items": { "type": "string" }, "type": "array" }, "allowGuests": { "description": "Whether people without an account may join.", "type": "boolean" }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "durationMin": { "description": "Duration in minutes.", "type": "integer" }, "hostId": { "description": "Id of the meeting host.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "joinCode": { "description": "Code guests use to join.", "type": "string" }, "joinPath": { "description": "Path of the join page.", "type": "string" }, "lobbyEnabled": { "description": "Whether guests wait in a lobby until admitted.", "type": "boolean" }, "lockedAt": { "description": "When it was locked (ISO 8601); null when unlocked.", "format": "date-time", "type": [ "string", "null" ] }, "recordingEnabled": { "description": "Whether the meeting is recorded.", "type": "boolean" }, "roomName": { "description": "Real-time room the call or meeting runs in.", "type": "string" }, "scheduledAt": { "description": "Scheduled start (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "type": "string" }, "timezone": { "description": "IANA time zone, e.g. America/Santiago.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "description", "hostId", "conversationId", "timezone", "roomName", "joinCode", "state", "scheduledAt", "lockedAt", "durationMin", "lobbyEnabled", "allowGuests", "recordingEnabled", "admittedIdentities", "createdAt", "joinPath" ], "type": [ "object", "null" ] } }, "required": [ "meeting" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update meeting", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/meetings/queries/get-meeting": { "post": { "description": "Get meeting\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-queries-get-meeting", "requestBody": { "content": { "application/json": { "example": { "args": [ { "joinCode": "", "meetingId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "joinCode": { "type": "string" }, "meetingId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "isHost": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "isHost": { "type": "boolean" } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get meeting", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/meetings/queries/get-meeting-recording-url": { "post": { "description": "Get meeting recording url\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-queries-get-meeting-recording-url", "requestBody": { "content": { "application/json": { "example": { "args": [ { "recordingId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "recordingId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get meeting recording url", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/meetings/queries/list-meetings": { "post": { "description": "List meetings\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-meetings-queries-list-meetings", "requestBody": { "content": { "application/json": { "example": { "args": [ { "scope": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "scope": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "meetings": [ { "id": "string", "title": "string", "description": "string", "hostId": "string", "hostName": "string", "mine": true, "state": "string", "scheduledAt": "2026-01-31T12:00:00Z", "durationMin": 0, "joinCode": "string", "joinPath": "string", "lobbyEnabled": true, "allowGuests": true, "recordingEnabled": true, "conversationId": "string", "invites": 0, "recordings": 0, "liveCallId": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "meetings": { "items": { "properties": { "allowGuests": { "description": "Whether people without an account may join.", "type": "boolean" }, "conversationId": { "description": "Chat conversation id.", "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "durationMin": { "description": "Duration in minutes.", "type": "integer" }, "hostId": { "description": "Id of the meeting host.", "type": "string" }, "hostName": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "invites": { "type": "integer" }, "joinCode": { "description": "Code guests use to join.", "type": "string" }, "joinPath": { "description": "Path of the join page.", "type": "string" }, "liveCallId": { "type": "string" }, "lobbyEnabled": { "description": "Whether guests wait in a lobby until admitted.", "type": "boolean" }, "mine": { "description": "Whether it belongs to the API key's acting user.", "type": "boolean" }, "recordingEnabled": { "description": "Whether the meeting is recorded.", "type": "boolean" }, "recordings": { "type": "integer" }, "scheduledAt": { "description": "Scheduled start (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "Current state.", "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title", "description", "hostId", "hostName", "mine", "state", "scheduledAt", "durationMin", "joinCode", "joinPath", "lobbyEnabled", "allowGuests", "recordingEnabled", "conversationId", "invites", "recordings", "liveCallId" ], "type": "object" }, "type": "array" } }, "required": [ "meetings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List meetings", "tags": [ "Communications" ], "x-required-scope": "communications:read" } }, "/api/actions/notifications/mutations/dismiss-notice": { "post": { "description": "Dismiss notice\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-notifications-mutations-dismiss-notice", "requestBody": { "content": { "application/json": { "example": { "args": [ { "key": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "key": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "success": true }, "schema": { "properties": { "success": { "description": "Whether the action completed.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Dismiss notice", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/notifications/mutations/mark-notifications-read": { "post": { "description": "Mark notifications read\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-notifications-mutations-mark-notifications-read", "requestBody": { "content": { "application/json": { "example": { "args": [ { "deliveryId": "", "ids": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "deliveryId": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "success": true }, "schema": { "properties": { "success": { "description": "Whether the action completed.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"communications:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"communications:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "communications:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark notifications read", "tags": [ "Communications" ], "x-modifies-data": true, "x-required-scope": "communications:write" } }, "/api/actions/ojv/queries/get-ojv-catalogs": { "post": { "description": "OJV reference catalogs (courts, competencias, …).\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-ojv-queries-get-ojv-catalogs", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "competences": [ { "label": "string", "value": "string", "valueNumber": "string" } ], "courts": [ { "value": 0, "label": "string" } ], "tribunals": [ { "competence": "string", "tribunalId": 0, "corteId": 0, "name": "string", "courtLabel": "string", "competenceCode": 0, "altNames": [ "string" ] } ], "rolTypesByCompetence": { "\u003ckey\u003e": {} } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "competences": { "items": { "properties": { "label": { "description": "Human-readable label.", "type": "string" }, "value": { "description": "Value.", "type": "string" }, "valueNumber": { "type": "string" } }, "required": [ "label", "value", "valueNumber" ], "type": "object" }, "type": "array" }, "courts": { "items": { "properties": { "label": { "description": "Human-readable label.", "type": "string" }, "value": { "description": "Value.", "type": "integer" } }, "required": [ "value", "label" ], "type": "object" }, "type": "array" }, "rolTypesByCompetence": { "additionalProperties": {}, "description": "Keyed by competence; each value is an array of rol types {value: string, name: string, earlyThan2018: boolean|null, corteId: integer|null}.", "type": "object" }, "tribunals": { "items": { "properties": { "altNames": { "items": { "type": "string" }, "type": "array" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "competenceCode": { "type": "integer" }, "corteId": { "description": "PJUD court of appeals id.", "type": "integer" }, "courtLabel": { "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" } }, "required": [ "competence", "tribunalId", "corteId", "name", "courtLabel", "competenceCode", "altNames" ], "type": "object" }, "type": "array" } }, "required": [ "competences", "courts", "tribunals", "rolTypesByCompetence" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reference:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reference:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reference:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get ojv catalogs", "tags": [ "PJUD causas" ], "x-required-scope": "reference:read" } }, "/api/actions/onboarding/wizard/get-onboarding": { "post": { "description": "Get onboarding\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-onboarding-wizard-get-onboarding", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "pending": true, "step": "string", "completed": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "completed": { "type": "boolean" }, "pending": { "description": "Number pending.", "type": "boolean" }, "step": { "type": "string" } }, "required": [ "pending", "step", "completed" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get onboarding", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/onboarding/wizard/save-onboarding": { "post": { "description": "Save onboarding\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-onboarding-wizard-save-onboarding", "requestBody": { "content": { "application/json": { "example": { "args": [ { "finish": false, "skippedSync": false, "step": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "finish": { "type": "boolean" }, "skippedSync": { "type": "boolean" }, "step": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save onboarding", "tags": [ "Other product features" ], "x-modifies-data": true, "x-required-scope": "product:write" } }, "/api/actions/onboarding/wizard/start-onboarding-sync": { "post": { "description": "Start onboarding sync\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-onboarding-wizard-start-onboarding-sync", "requestBody": { "content": { "application/json": { "example": { "args": [ { "clientId": "", "materias": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "clientId": { "type": "string" }, "materias": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "sourceId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "sourceId": { "description": "Id of the record in its source.", "type": "string" } }, "required": [ "sourceId" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start onboarding sync", "tags": [ "Other product features" ], "x-modifies-data": true, "x-required-scope": "product:write" } }, "/api/actions/preferences/calendar/get-calendar-sync-status": { "post": { "description": "Get calendar sync status\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-preferences-calendar-get-calendar-sync-status", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "providers": [ { "provider": "string", "configured": true, "status": "string", "lastSyncAt": "2026-01-31T12:00:00Z", "lastError": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "providers": { "items": { "properties": { "configured": { "type": "boolean" }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": [ "string", "null" ] }, "lastSyncAt": { "format": "date-time", "type": [ "string", "null" ] }, "provider": { "description": "Provider.", "type": "string" }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "provider", "configured" ], "type": "object" }, "type": "array" } }, "required": [ "providers" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get calendar sync status", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/public/boletas/lookup-boleta": { "post": { "description": "Lookup boleta\n\nAuthentication: none. Public reference endpoint. Body: `{\"args\": [...]}`.", "operationId": "actions-public-boletas-lookup-boleta", "responses": { "200": { "content": { "application/json": { "example": { "data": { "found": true, "tipo": 0, "tipoNombre": "string", "folio": 0, "fecha": "string", "total": 0, "aceptada": true, "emisor": "string", "rutEmisor": "string", "pdfUrl": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "aceptada": { "type": "boolean" }, "emisor": { "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "type": "string" }, "folio": { "description": "Folio number in the court file.", "type": "integer" }, "found": { "type": "boolean" }, "pdfUrl": { "type": "string" }, "rutEmisor": { "type": "string" }, "tipo": { "description": "Record type.", "type": "integer" }, "tipoNombre": { "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "found" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [], "summary": "Lookup boleta", "tags": [ "Reference data" ] } }, "/api/actions/public/ojv-status/get-public-ojv-status-snapshot": { "post": { "description": "Get public ojv status snapshot\n\nAuthentication: none. Public reference endpoint. Body: `{\"args\": [...]}`.", "operationId": "actions-public-ojv-status-get-public-ojv-status-snapshot", "responses": { "200": { "content": { "application/json": { "example": { "data": { "current": { "id": "string", "checkedAt": "string", "pageStatus": "string", "responseTimeMs": 0, "httpStatusCode": 0, "status": "string", "errorCategory": "string", "textErrorDesc": "string", "textErrorTrace": "string", "clientTextError": "string", "dataValidated": true, "validationErrors": [ "string" ] }, "today": [ { "id": "string", "checkedAt": "string", "pageStatus": "string", "responseTimeMs": 0, "httpStatusCode": 0, "status": "string", "errorCategory": "string", "textErrorDesc": "string", "textErrorTrace": "string", "clientTextError": "string", "dataValidated": true, "validationErrors": [ "string" ] } ], "history": [ { "date": "string", "totalChecks": 0, "upChecks": 0, "downChecks": 0, "uptimePercentage": 0, "avgResponseTime": 0, "minResponseTime": 0, "maxResponseTime": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "current": { "properties": { "checkedAt": { "type": "string" }, "clientTextError": { "type": [ "string", "null" ] }, "dataValidated": { "type": [ "boolean", "null" ] }, "errorCategory": { "description": "Category of the last scraping error.", "type": [ "string", "null" ] }, "httpStatusCode": { "type": [ "integer", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "pageStatus": { "type": "string" }, "responseTimeMs": { "type": [ "integer", "null" ] }, "status": { "description": "Current status.", "type": [ "string", "null" ] }, "textErrorDesc": { "description": "Detail of the last scraping error.", "type": [ "string", "null" ] }, "textErrorTrace": { "type": [ "string", "null" ] }, "validationErrors": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "checkedAt", "pageStatus", "responseTimeMs", "httpStatusCode", "status", "errorCategory", "textErrorDesc", "textErrorTrace", "clientTextError", "dataValidated", "validationErrors" ], "type": [ "object", "null" ] }, "history": { "items": { "properties": { "avgResponseTime": { "type": [ "number", "null" ] }, "date": { "description": "Date (ISO 8601).", "type": "string" }, "downChecks": { "type": "integer" }, "maxResponseTime": { "type": [ "integer", "null" ] }, "minResponseTime": { "type": [ "integer", "null" ] }, "totalChecks": { "type": "integer" }, "upChecks": { "type": "integer" }, "uptimePercentage": { "type": "number" } }, "required": [ "date", "totalChecks", "upChecks", "downChecks", "uptimePercentage", "avgResponseTime", "minResponseTime", "maxResponseTime" ], "type": "object" }, "type": "array" }, "today": { "items": { "properties": { "checkedAt": { "type": "string" }, "clientTextError": { "type": [ "string", "null" ] }, "dataValidated": { "type": [ "boolean", "null" ] }, "errorCategory": { "description": "Category of the last scraping error.", "type": [ "string", "null" ] }, "httpStatusCode": { "type": [ "integer", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "pageStatus": { "type": "string" }, "responseTimeMs": { "type": [ "integer", "null" ] }, "status": { "description": "Current status.", "type": [ "string", "null" ] }, "textErrorDesc": { "description": "Detail of the last scraping error.", "type": [ "string", "null" ] }, "textErrorTrace": { "type": [ "string", "null" ] }, "validationErrors": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "checkedAt", "pageStatus", "responseTimeMs", "httpStatusCode", "status", "errorCategory", "textErrorDesc", "textErrorTrace", "clientTextError", "dataValidated", "validationErrors" ], "type": "object" }, "type": "array" } }, "required": [ "current", "today", "history" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [], "summary": "Get public ojv status snapshot", "tags": [ "Reference data" ] } }, "/api/actions/public/system-status/get-public-system-status-snapshot": { "post": { "description": "Get public system status snapshot\n\nAuthentication: none. Public reference endpoint. Body: `{\"args\": [...]}`.", "operationId": "actions-public-system-status-get-public-system-status-snapshot", "responses": { "200": { "content": { "application/json": { "example": { "data": { "checks": [ { "key": "string", "subsystem": "string", "status": "string", "observedValue": "string", "threshold": "string", "message": "string", "source": "string", "observedAt": "2026-01-31T12:00:00Z", "days": [ { "date": "2026-01-31", "total": 0, "healthy": 0, "degraded": 0, "failing": 0 } ] } ], "historyDays": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "checks": { "description": "Latest result (last 24 h) of each public check.", "items": { "properties": { "days": { "description": "Daily history (Chile days), oldest first.", "items": { "properties": { "date": { "description": "Date (ISO 8601).", "format": "date", "type": "string" }, "degraded": { "type": "integer" }, "failing": { "type": "integer" }, "healthy": { "type": "integer" }, "total": { "description": "Observations that day.", "type": "integer" } }, "required": [ "date", "total", "healthy", "degraded", "failing" ], "type": "object" }, "type": "array" }, "key": { "description": "Check key.", "type": "string" }, "message": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "observedValue": { "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "type": "string" }, "status": { "description": "Latest status of the check.", "type": "string" }, "subsystem": { "type": "string" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "key", "subsystem", "status", "observedValue", "threshold", "message", "source", "observedAt", "days" ], "type": "object" }, "type": "array" }, "historyDays": { "description": "Days of history the page shows; absent when the snapshot could not be read.", "type": "integer" } }, "required": [ "checks" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [], "summary": "Get public system status snapshot", "tags": [ "Reference data" ] } }, "/api/actions/reports/advanced/get-billing-report": { "post": { "description": "Get billing report\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-advanced-get-billing-report", "requestBody": { "content": { "application/json": { "example": { "args": [ { "from": "", "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "from": "2026-01-31", "to": "2026-01-31", "totals": [ { "currency": "string", "collected": 0, "tax": 0, "net": 0, "pending": 0, "overdue": 0 } ], "byMonth": [ { "month": "string", "currency": "string", "billed": 0, "collected": 0 } ], "byStatus": [ { "status": "DRAFT", "currency": "string", "count": 0, "total": 0 } ], "topClients": [ { "client": "string", "currency": "string", "billed": 0, "collected": 0 } ], "issued": [ { "currency": "string", "notes": 0, "clients": 0, "billed": 0 } ], "byKind": [ { "kind": "HOURS", "currency": "string", "amount": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "byKind": { "description": "Billed amounts by note line kind.", "items": { "properties": { "amount": { "description": "Amount.", "type": "number" }, "currency": { "type": "string" }, "kind": { "description": "Record subtype.", "enum": [ "HOURS", "FIXED", "EXPENSE" ], "type": "string" } }, "required": [ "kind", "currency", "amount" ], "type": "object" }, "type": "array" }, "byMonth": { "items": { "properties": { "billed": { "description": "Total of notes that are neither DRAFT nor CANCELLED.", "type": "number" }, "collected": { "description": "Total of PAID notes.", "type": "number" }, "currency": { "type": "string" }, "month": { "description": "YYYY-MM in Chile time.", "type": "string" } }, "required": [ "month", "currency", "billed", "collected" ], "type": "object" }, "type": "array" }, "byStatus": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "currency": { "type": "string" }, "status": { "description": "Current status.", "enum": [ "DRAFT", "ISSUED", "OVERDUE", "PAID", "CANCELLED" ], "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": "number" } }, "required": [ "status", "currency", "count", "total" ], "type": "object" }, "type": "array" }, "from": { "description": "Start of the range (ISO 8601).", "format": "date", "type": "string" }, "issued": { "items": { "properties": { "billed": { "type": "number" }, "clients": { "description": "Distinct clients billed.", "type": "integer" }, "currency": { "type": "string" }, "notes": { "description": "Notes issued (not DRAFT or CANCELLED).", "type": "integer" } }, "required": [ "currency", "notes", "clients", "billed" ], "type": "object" }, "type": "array" }, "to": { "description": "End of the range (ISO 8601).", "format": "date", "type": "string" }, "topClients": { "description": "Top 10 clients by billed amount.", "items": { "properties": { "billed": { "type": "number" }, "client": { "description": "Client name.", "type": "string" }, "collected": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "client", "currency", "billed", "collected" ], "type": "object" }, "type": "array" }, "totals": { "description": "Per-currency totals of notes dated in the range (never summed across currencies).", "items": { "properties": { "collected": { "description": "Total of PAID notes.", "type": "number" }, "currency": { "type": "string" }, "net": { "description": "Net of PAID notes.", "type": "number" }, "overdue": { "description": "Total of OVERDUE notes.", "type": "number" }, "pending": { "description": "Total of ISSUED and OVERDUE notes.", "type": "number" }, "tax": { "description": "Tax of PAID notes.", "type": "number" } }, "required": [ "currency", "collected", "tax", "net", "pending", "overdue" ], "type": "object" }, "type": "array" } }, "required": [ "from", "to", "totals", "byMonth", "byStatus", "topClients", "issued", "byKind" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get billing report", "tags": [ "Reports" ], "x-required-scope": "reports:read" } }, "/api/actions/reports/advanced/get-internal-report": { "post": { "description": "Get internal report\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-advanced-get-internal-report", "requestBody": { "content": { "application/json": { "example": { "args": [ { "from": "", "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "from": "string", "to": "string", "cases": { "active": 0, "stopped": 0, "closed": 0, "total": 0 }, "byState": [ { "label": "string", "count": 0 } ], "tasks": { "onTime": 0, "late": 0, "overdue": 0, "open": 0 }, "people": [ { "userId": "string", "name": "string", "cases": 0, "onTime": 0, "late": 0, "overdue": 0, "open": 0, "minutes": 0, "billableMinutes": 0 } ], "hoursByUser": [ { "id": "string", "label": "string", "minutes": 0, "billableMinutes": 0 } ], "hoursByClient": [ { "id": "string", "label": "string", "minutes": 0, "billableMinutes": 0 } ], "totalMinutes": 0, "hoursAll": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "byState": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "cases": { "description": "Internal cases by status folded from the org-defined state.", "properties": { "active": { "description": "Whether the record is active.", "type": "integer" }, "closed": { "type": "integer" }, "stopped": { "type": "integer" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "active", "stopped", "closed", "total" ], "type": "object" }, "from": { "description": "Start of the range (ISO 8601).", "type": "string" }, "hoursAll": { "type": "boolean" }, "hoursByClient": { "items": { "properties": { "billableMinutes": { "description": "Billable minutes.", "type": "integer" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "minutes": { "description": "Minutes.", "type": "integer" } }, "required": [ "id", "label", "minutes", "billableMinutes" ], "type": "object" }, "type": "array" }, "hoursByUser": { "items": { "properties": { "billableMinutes": { "description": "Billable minutes.", "type": "integer" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "minutes": { "description": "Minutes.", "type": "integer" } }, "required": [ "id", "label", "minutes", "billableMinutes" ], "type": "object" }, "type": "array" }, "people": { "items": { "properties": { "billableMinutes": { "description": "Billable minutes.", "type": "integer" }, "cases": { "description": "Cases.", "type": "integer" }, "late": { "type": "integer" }, "minutes": { "description": "Minutes.", "type": "integer" }, "name": { "description": "Display name.", "type": "string" }, "onTime": { "type": "integer" }, "open": { "type": "integer" }, "overdue": { "type": "integer" }, "userId": { "description": "User id.", "type": "string" } }, "required": [ "userId", "name", "cases", "onTime", "late", "overdue", "open", "minutes", "billableMinutes" ], "type": "object" }, "type": "array" }, "tasks": { "properties": { "late": { "description": "Completed in the period after the due day.", "type": "integer" }, "onTime": { "description": "Completed in the period by the due day.", "type": "integer" }, "open": { "description": "Open and not overdue.", "type": "integer" }, "overdue": { "description": "Open and past the due day.", "type": "integer" } }, "required": [ "onTime", "late", "overdue", "open" ], "type": "object" }, "to": { "description": "End of the range (ISO 8601).", "type": "string" }, "totalMinutes": { "type": "integer" } }, "required": [ "from", "to", "cases", "byState", "tasks", "people", "hoursByUser", "hoursByClient", "totalMinutes", "hoursAll" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get internal report", "tags": [ "Reports" ], "x-required-scope": "reports:read" } }, "/api/actions/reports/advanced/get-judicial-report": { "post": { "description": "Get judicial report\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-advanced-get-judicial-report", "requestBody": { "content": { "application/json": { "example": { "args": [ { "attributeId": "", "attributeValue": "", "clientId": "", "competence": "", "estado": "", "etapa": "", "includeArchived": false, "lawyerId": "", "tribunalId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "attributeId": { "type": "string" }, "attributeValue": { "type": "string" }, "clientId": { "type": "string" }, "competence": { "type": "string" }, "estado": { "type": "string" }, "etapa": { "type": "string" }, "includeArchived": { "type": "boolean" }, "lawyerId": { "type": "string" }, "tribunalId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "total": 0, "byEstado": [ { "label": "string", "count": 0 } ], "byEtapa": [ { "label": "string", "count": 0 } ], "byCompetence": [ { "label": "string", "count": 0 } ], "topTribunals": [ { "competence": "string", "corteId": 0, "tribunalId": 0, "count": 0 } ], "activity": [ { "key": "string", "count": 0, "percent": 0 } ], "rows": [ { "id": "string", "rol": "string", "caratulado": "string", "competence": "string", "corteId": 0, "tribunalId": 0, "cuaderno": "string", "materia": "string", "clients": "string", "estado": "string", "lastMovement": "2026-01-31T12:00:00Z", "summary": "string" } ], "rowsTruncated": true, "options": { "clients": [ { "id": "string", "label": "string" } ], "lawyers": [ { "id": "string", "label": "string" } ], "attributes": [ { "id": "string", "label": "string" } ] } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "activity": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "key": { "description": "Stable key.", "type": "string" }, "percent": { "type": "number" } }, "required": [ "key", "count", "percent" ], "type": "object" }, "type": "array" }, "byCompetence": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byEstado": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byEtapa": { "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "options": { "description": "Pickers for the report filters.", "properties": { "attributes": { "description": "Causa custom attributes.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "clients": { "description": "Clients linked to the record.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "lawyers": { "description": "Organization members.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" } }, "required": [ "clients", "lawyers", "attributes" ], "type": "object" }, "rows": { "description": "The records on this page.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "clients": { "description": "Clients linked to the record.", "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "cuaderno": { "description": "Cuaderno (case-file notebook).", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "lastMovement": { "format": "date-time", "type": [ "string", "null" ] }, "materia": { "description": "Subject matter.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "summary": { "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "rol", "caratulado", "competence", "corteId", "tribunalId", "cuaderno", "materia", "clients", "estado", "lastMovement", "summary" ], "type": "object" }, "type": "array" }, "rowsTruncated": { "type": "boolean" }, "topTribunals": { "items": { "properties": { "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "count": { "description": "Number of records.", "type": "integer" }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "competence", "corteId", "tribunalId", "count" ], "type": "object" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "total", "byEstado", "byEtapa", "byCompetence", "topTribunals", "activity", "rows", "rowsTruncated", "options" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get judicial report", "tags": [ "Reports" ], "x-required-scope": "reports:read" } }, "/api/actions/reports/dashboards/delete-report-dashboard": { "post": { "description": "Delete report dashboard\n\nAuthentication: developer API key. Required scope: `reports:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-dashboards-delete-report-dashboard", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "success": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "success": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete report dashboard", "tags": [ "Reports" ], "x-modifies-data": true, "x-required-scope": "reports:write" } }, "/api/actions/reports/dashboards/list-report-dashboards": { "post": { "description": "List report dashboards\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-dashboards-list-report-dashboards", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "dashboards": [ { "id": "string", "ownerId": "string", "ownerName": "string", "name": "string", "shared": true, "widgets": [ { "type": "string", "size": "string", "filters": { "\u003ckey\u003e": "string" } } ], "canEdit": true, "updatedAt": "2026-01-31T12:00:00Z" } ], "canBilling": true, "widgetTypes": [ "string" ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canBilling": { "type": "boolean" }, "dashboards": { "items": { "properties": { "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "ownerId": { "type": "string" }, "ownerName": { "type": "string" }, "shared": { "type": "boolean" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "widgets": { "items": { "properties": { "filters": { "additionalProperties": { "type": "string" }, "description": "Widget filters (up to 10), keyed by filter name.", "type": "object" }, "size": { "type": "string" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "type", "size", "filters" ], "type": "object" }, "type": "array" } }, "required": [ "id", "ownerId", "ownerName", "name", "shared", "widgets", "canEdit", "updatedAt" ], "type": "object" }, "type": "array" }, "widgetTypes": { "items": { "type": "string" }, "type": "array" } }, "required": [ "dashboards", "canBilling", "widgetTypes" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List report dashboards", "tags": [ "Reports" ], "x-required-scope": "reports:read" } }, "/api/actions/reports/dashboards/save-report-dashboard": { "post": { "description": "Save report dashboard\n\nAuthentication: developer API key. Required scope: `reports:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-dashboards-save-report-dashboard", "requestBody": { "content": { "application/json": { "example": { "args": [ { "canEdit": false, "id": "", "name": "", "ownerId": "", "ownerName": "", "shared": false, "updatedAt": "2026-01-01T00:00:00Z", "widgets": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "canEdit": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "ownerId": { "type": "string" }, "ownerName": { "type": "string" }, "shared": { "type": "boolean" }, "updatedAt": { "type": "string" }, "widgets": { "items": { "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save report dashboard", "tags": [ "Reports" ], "x-modifies-data": true, "x-required-scope": "reports:write" } }, "/api/actions/reports/queries/get-causes-pending-report": { "post": { "description": "Get causes pending report\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-queries-get-causes-pending-report", "requestBody": { "content": { "application/json": { "example": { "args": [ { "bucket": "", "competence": "", "from": "", "includeArchived": false, "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "bucket": { "type": "string" }, "competence": { "type": "string" }, "from": { "type": "string" }, "includeArchived": { "type": "boolean" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "total": 0, "order": [ "string" ], "counts": { "\u003ckey\u003e": 0 }, "docErrorTotal": 0, "suspectFechaIngreso": 0, "historia": { "withDocErrors": 0, "causasWithDocErrors": 0, "docErrorTotal": 0 }, "bucket": "string", "rows": [ { "id": "string", "rol": "string", "caratulado": "string", "competence": "string", "corteId": 0, "tribunalId": 0, "status": "string", "errorCategory": "string", "lastUpdate": "2026-01-31T12:00:00Z", "lastChangeAt": "2026-01-31T12:00:00Z", "docErrorCount": 0 } ], "rowsTruncated": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "bucket": { "type": "string" }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Causas per pending bucket, keyed by the bucket ids listed in order.", "type": "object" }, "docErrorTotal": { "type": "integer" }, "historia": { "description": "Movement history, newest first.", "properties": { "causasWithDocErrors": { "type": "integer" }, "docErrorTotal": { "type": "integer" }, "withDocErrors": { "type": "integer" } }, "required": [ "withDocErrors", "causasWithDocErrors", "docErrorTotal" ], "type": "object" }, "order": { "description": "Sort position.", "items": { "type": "string" }, "type": "array" }, "rows": { "description": "Up to 100 causas of the selected bucket, longest unchanged first; empty without a bucket.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "competence": { "description": "Competence enum name (CIVIL, LABORAL, ...).", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "docErrorCount": { "type": "integer" }, "errorCategory": { "description": "Scrape error category label; empty when none.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "lastChangeAt": { "description": "Last change detected in the causa.", "format": "date-time", "type": [ "string", "null" ] }, "lastUpdate": { "description": "Last scrape.", "format": "date-time", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "status": { "description": "Scrape status label.", "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "rol", "caratulado", "competence", "corteId", "tribunalId", "status", "errorCategory", "lastUpdate", "lastChangeAt", "docErrorCount" ], "type": "object" }, "type": "array" }, "rowsTruncated": { "type": "boolean" }, "suspectFechaIngreso": { "type": "integer" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "total", "counts", "docErrorTotal", "suspectFechaIngreso", "rows" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get causes pending report", "tags": [ "Reports" ], "x-required-scope": "reports:read" } }, "/api/actions/reports/queries/get-causes-state-report": { "post": { "description": "Causa state report.\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-queries-get-causes-state-report", "requestBody": { "content": { "application/json": { "example": { "args": [ { "bucket": "", "competence": "", "from": "", "includeArchived": false, "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "bucket": { "type": "string" }, "competence": { "type": "string" }, "from": { "type": "string" }, "includeArchived": { "type": "boolean" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "total": 0, "byCompetence": [ { "label": "string", "count": 0 } ], "byEstado": [ { "label": "string", "count": 0 } ], "byEstadoOtros": 0, "byEtapa": [ { "label": "string", "count": 0 } ], "byEtapaOtros": 0, "byTipoProcedimiento": [ { "label": "string", "count": 0 } ], "byTipoProcedimientoOtros": 0, "byCorte": [ { "id": 0, "count": 0 } ], "byTribunal": [ { "competence": "string", "corteId": 0, "tribunalId": 0, "count": 0 } ], "ageBuckets": { "order": [ "string" ], "counts": { "\u003ckey\u003e": 0 } }, "idleBuckets": { "order": [ "string" ], "counts": { "\u003ckey\u003e": 0 } }, "ageCounts": null, "idleCounts": null } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ageBuckets": { "properties": { "counts": { "additionalProperties": { "type": "integer" }, "description": "Causas per age bucket (days since fecha de ingreso).", "type": "object" }, "order": { "description": "Sort position.", "items": { "type": "string" }, "type": "array" } }, "required": [ "order", "counts" ], "type": "object" }, "ageCounts": { "type": "null" }, "byCompetence": { "description": "Top 10 competences; label is the competence enum name.", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byCorte": { "description": "Top 30 cortes.", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "id": { "description": "OJV corte id.", "type": [ "integer", "null" ] } }, "required": [ "id", "count" ], "type": "object" }, "type": "array" }, "byEstado": { "description": "Top 25 estados.", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byEstadoOtros": { "type": "number" }, "byEtapa": { "description": "Top 25 etapas.", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byEtapaOtros": { "type": "number" }, "byTipoProcedimiento": { "description": "Top 25 procedure types.", "items": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "label", "count" ], "type": "object" }, "type": "array" }, "byTipoProcedimientoOtros": { "type": "number" }, "byTribunal": { "description": "Top 30 tribunals.", "items": { "properties": { "competence": { "description": "Competence enum name.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "count": { "description": "Number of records.", "type": "integer" }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "competence", "corteId", "tribunalId", "count" ], "type": "object" }, "type": "array" }, "idleBuckets": { "properties": { "counts": { "additionalProperties": { "type": "integer" }, "description": "Causas per idle bucket (days since the last change).", "type": "object" }, "order": { "description": "Sort position.", "items": { "type": "string" }, "type": "array" } }, "required": [ "order", "counts" ], "type": "object" }, "idleCounts": { "type": "null" }, "total": { "description": "Total number of matching records across all pages.", "type": [ "integer", "null" ] } }, "required": [ "total", "byCompetence", "byEstado", "byEstadoOtros", "byEtapa", "byEtapaOtros", "byTipoProcedimiento", "byTipoProcedimientoOtros", "byCorte", "byTribunal" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get causes state report", "tags": [ "Reports" ], "x-required-scope": "reports:read" } }, "/api/actions/reports/queries/get-causes-timing-report": { "post": { "description": "Get causes timing report\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-queries-get-causes-timing-report", "requestBody": { "content": { "application/json": { "example": { "args": [ { "bucket": "", "competence": "", "from": "", "includeArchived": false, "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "bucket": { "type": "string" }, "competence": { "type": "string" }, "from": { "type": "string" }, "includeArchived": { "type": "boolean" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "sample": 0, "withMovements": 0, "withoutMovements": 0, "avgIdleDays": 0, "medianIdleDays": 0, "p90IdleDays": 0, "avgDwnc": 0, "medianDwnc": 0, "resolutionSample": 0, "avgResolutionDays": 0, "medianResolutionDays": 0, "p90ResolutionDays": 0, "avgAgeDays": 0, "medianAgeDays": 0, "idleBuckets": { "order": [ "string" ], "counts": { "\u003ckey\u003e": 0 } }, "slowestTribunals": [ { "competence": "string", "corteId": 0, "tribunalId": 0, "causas": 0, "sample": 0, "avgResolutionDays": 0, "medianResolutionDays": 0 } ], "mostIdle": [ { "id": "string", "rol": "string", "caratulado": "string", "competence": "string", "corteId": 0, "tribunalId": 0, "idleDays": 0, "lastChangeAt": "2026-01-31T12:00:00Z" } ], "idleCounts": null } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "avgAgeDays": { "type": [ "number", "null" ] }, "avgDwnc": { "type": [ "number", "null" ] }, "avgIdleDays": { "type": [ "number", "null" ] }, "avgResolutionDays": { "description": "Average days between filings and resolutions.", "type": [ "number", "null" ] }, "idleBuckets": { "properties": { "counts": { "additionalProperties": { "type": "integer" }, "description": "Causas per idle bucket (days since the last change).", "type": "object" }, "order": { "description": "Sort position.", "items": { "type": "string" }, "type": "array" } }, "required": [ "order", "counts" ], "type": "object" }, "idleCounts": { "type": "null" }, "medianAgeDays": { "type": [ "number", "null" ] }, "medianDwnc": { "description": "Median days without new changes.", "type": [ "integer", "null" ] }, "medianIdleDays": { "type": [ "number", "null" ] }, "medianResolutionDays": { "type": [ "number", "null" ] }, "mostIdle": { "description": "Up to 50 causas with movements, longest idle first.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "competence": { "description": "Competence enum name.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "idleDays": { "type": [ "integer", "null" ] }, "lastChangeAt": { "description": "When PJUD last showed a change (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "id", "rol", "caratulado", "competence", "corteId", "tribunalId", "idleDays", "lastChangeAt" ], "type": "object" }, "type": "array" }, "p90IdleDays": { "type": [ "number", "null" ] }, "p90ResolutionDays": { "type": [ "number", "null" ] }, "resolutionSample": { "type": "integer" }, "sample": { "type": "integer" }, "slowestTribunals": { "description": "Up to 20 tribunals with at least 5 measured causas, slowest first.", "items": { "properties": { "avgResolutionDays": { "description": "Average days between filings and resolutions.", "type": "number" }, "causas": { "description": "PJUD causas.", "type": "integer" }, "competence": { "description": "Competence enum name.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "medianResolutionDays": { "type": "number" }, "sample": { "description": "Causas with a known average resolution time.", "type": "integer" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" } }, "required": [ "competence", "corteId", "tribunalId", "causas", "sample", "avgResolutionDays", "medianResolutionDays" ], "type": "object" }, "type": "array" }, "withMovements": { "type": "integer" }, "withoutMovements": { "type": "integer" } }, "required": [ "sample", "withMovements", "withoutMovements", "avgIdleDays", "medianIdleDays", "p90IdleDays", "avgDwnc", "medianDwnc", "resolutionSample", "avgResolutionDays", "medianResolutionDays", "p90ResolutionDays", "avgAgeDays", "medianAgeDays", "slowestTribunals", "mostIdle" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get causes timing report", "tags": [ "Reports" ], "x-required-scope": "reports:read" } }, "/api/actions/reports/queries/get-causes-workload-report": { "post": { "description": "Get causes workload report\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-reports-queries-get-causes-workload-report", "requestBody": { "content": { "application/json": { "example": { "args": [ { "bucket": "", "competence": "", "from": "", "includeArchived": false, "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "bucket": { "type": "string" }, "competence": { "type": "string" }, "from": { "type": "string" }, "includeArchived": { "type": "boolean" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "canViewAllTeams": true, "total": 0, "withoutResponsible": 0, "untagged": 0, "tasksWithoutCausa": 0, "byUser": [ { "id": "string", "name": "string", "causas": 0, "causasErrored": 0, "causasIdle30d": 0, "tasksOpen": 0, "tasksPending": 0, "tasksInProgress": 0, "tasksHighPriority": 0, "tasksOverdue": 0, "tasksDueNext7d": 0 } ], "byTeam": [ { "id": "string", "name": "string", "causas": 0, "causasErrored": 0, "causasIdle30d": 0, "tasksOpen": 0, "tasksPending": 0, "tasksInProgress": 0, "tasksHighPriority": 0, "tasksOverdue": 0, "tasksDueNext7d": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "byTeam": { "items": { "properties": { "causas": { "description": "Causas where it is the responsible attorney (byUser) or tagged with the team (byTeam).", "type": "integer" }, "causasErrored": { "description": "Of those, causas whose scrape status is an error.", "type": "integer" }, "causasIdle30d": { "description": "Of those, causas with no change in more than 30 days.", "type": "integer" }, "id": { "description": "Team id.", "type": [ "string", "null" ] }, "name": { "description": "Display name.", "type": "string" }, "tasksDueNext7d": { "type": "integer" }, "tasksHighPriority": { "description": "Open tasks with HIGH or URGENT priority.", "type": "integer" }, "tasksInProgress": { "type": "integer" }, "tasksOpen": { "description": "Open tasks (PENDING or IN_PROGRESS).", "type": "integer" }, "tasksOverdue": { "type": "integer" }, "tasksPending": { "type": "integer" } }, "required": [ "id", "name", "causas", "causasErrored", "causasIdle30d", "tasksOpen", "tasksPending", "tasksInProgress", "tasksHighPriority", "tasksOverdue", "tasksDueNext7d" ], "type": "object" }, "type": "array" }, "byUser": { "items": { "properties": { "causas": { "description": "Causas where it is the responsible attorney (byUser) or tagged with the team (byTeam).", "type": "integer" }, "causasErrored": { "description": "Of those, causas whose scrape status is an error.", "type": "integer" }, "causasIdle30d": { "description": "Of those, causas with no change in more than 30 days.", "type": "integer" }, "id": { "description": "User id; null for open tasks with no assignee.", "type": [ "string", "null" ] }, "name": { "description": "Display name.", "type": "string" }, "tasksDueNext7d": { "type": "integer" }, "tasksHighPriority": { "description": "Open tasks with HIGH or URGENT priority.", "type": "integer" }, "tasksInProgress": { "type": "integer" }, "tasksOpen": { "description": "Open tasks (PENDING or IN_PROGRESS).", "type": "integer" }, "tasksOverdue": { "type": "integer" }, "tasksPending": { "type": "integer" } }, "required": [ "id", "name", "causas", "causasErrored", "causasIdle30d", "tasksOpen", "tasksPending", "tasksInProgress", "tasksHighPriority", "tasksOverdue", "tasksDueNext7d" ], "type": "object" }, "type": "array" }, "canViewAllTeams": { "type": "boolean" }, "tasksWithoutCausa": { "type": [ "integer", "null" ] }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" }, "untagged": { "type": "integer" }, "withoutResponsible": { "type": "integer" } }, "required": [ "total", "withoutResponsible", "untagged", "tasksWithoutCausa", "byUser", "byTeam" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reports:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reports:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reports:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get causes workload report", "tags": [ "Reports" ], "x-required-scope": "reports:read" } }, "/api/actions/rut-search/search-ruts": { "post": { "description": "Search ruts\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-rut-search-search-ruts", "requestBody": { "content": { "application/json": { "example": { "args": [ { "content": "", "direccion": "", "email": "", "limit": 0, "nombre": "", "number": "", "rut": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "content": { "type": "string" }, "direccion": { "type": "string" }, "email": { "type": "string" }, "limit": { "type": "number" }, "nombre": { "type": "string" }, "number": { "type": "string" }, "rut": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "count": 0, "limit": 0, "items": [ { "rut": "string", "nombre": "string", "sexo": "string", "domicilioElectoral": "string", "circunscripcion": "string", "mesa": "string", "emails": [ "string" ], "phones": [ "string" ], "source": "string", "cacheState": "string", "lastSyncedAt": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "count": { "description": "Number of records.", "type": "integer" }, "items": { "description": "The records returned.", "items": { "properties": { "cacheState": { "type": "string" }, "circunscripcion": { "type": "string" }, "domicilioElectoral": { "type": "string" }, "emails": { "items": { "type": "string" }, "type": "array" }, "lastSyncedAt": { "type": [ "string", "null" ] }, "mesa": { "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "phones": { "items": { "type": "string" }, "type": "array" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "sexo": { "type": "string" }, "source": { "description": "Where the record came from.", "type": "string" } }, "required": [ "rut", "nombre", "sexo", "domicilioElectoral", "circunscripcion" ], "type": "object" }, "type": "array" }, "limit": { "type": "integer" } }, "required": [ "count", "limit", "items" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reference:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reference:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reference:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search ruts", "tags": [ "Reference data" ], "x-required-scope": "reference:read" } }, "/api/actions/search/queries/global-search": { "post": { "description": "Global search\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-search-queries-global-search", "requestBody": { "content": { "application/json": { "example": { "args": [ { "group": "", "limit": 0, "query": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "group": { "type": "string" }, "limit": { "type": "number" }, "query": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "query": "string", "tooShort": true, "groups": [ { "key": "string", "items": [ { "id": "string", "title": "string", "subtitle": "string", "params": { "\u003ckey\u003e": "string" } } ], "more": true } ], "liquidacionesEnabled": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "groups": { "items": { "properties": { "items": { "description": "The records returned.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "params": { "additionalProperties": { "type": "string" }, "description": "What a client needs to build the hit's link; keys depend on the group (e.g. conversationId, kind, folderId, rut, status, rol parts).", "type": "object" }, "subtitle": { "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "id", "title" ], "type": "object" }, "type": "array" }, "key": { "description": "Stable key.", "type": "string" }, "more": { "description": "More is true when the group had more hits than the limit.", "type": "boolean" } }, "required": [ "key", "items", "more" ], "type": "object" }, "type": "array" }, "liquidacionesEnabled": { "type": "boolean" }, "query": { "description": "The query that was run.", "type": "string" }, "tooShort": { "type": "boolean" } }, "required": [ "query", "groups" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Global search", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/tablas/queries/get-scheduled-causes": { "post": { "description": "Get scheduled causes\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tablas-queries-get-scheduled-causes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "caratulado": "", "corteId": "", "from": "", "linkStatus": "", "page": 0, "per_page": 0, "removed": "", "rol": "", "sort": "", "tableName": "", "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "caratulado": { "type": "string" }, "corteId": { "type": "string" }, "from": { "type": "string" }, "linkStatus": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "removed": { "type": "string" }, "rol": { "type": "string" }, "sort": { "type": "string" }, "tableName": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "scheduledCauses": [ { "id": "string", "competence": "SUPREMA", "corteId": 0, "linkedCauses": [ { "rol": "string", "caratulado": "string", "c": "string", "causeId": "string" } ], "matchfound": true, "tableId": "string", "tableName": "string", "scheduledRoomId": "string", "scheduledRoomRef": "string", "scheduledRoomName": "string", "scheduledRoomDate": "2026-01-31T12:00:00Z", "position": 0, "caratulado": "string", "partialRol": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "changedAt": "2026-01-31T12:00:00Z", "changedText": "string", "removed": true, "relatedOrgIds": [ "string" ], "relatedTeamIds": [ "string" ] } ], "pageCount": 0, "total": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "scheduledCauses": { "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "changedText": { "description": "Save the actual change for display. Ej: change in position.", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "enum": [ "SUPREMA", "APELACIONES", "CIVIL", "LABORAL", "PENAL", "COBRANZA", "FAMILIA" ], "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": "integer" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "linkedCauses": { "items": { "properties": { "c": { "description": "Legacy spelling of caratulado.", "type": "string" }, "caratulado": { "description": "Legacy rows carry it as c instead.", "type": "string" }, "causeId": { "description": "Matched Nexulex causa, empty when none.", "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "rol" ], "type": "object" }, "type": "array" }, "matchfound": { "type": "boolean" }, "partialRol": { "description": "XX-XXXX", "type": "string" }, "position": { "description": "Position in the list.", "type": "integer" }, "relatedOrgIds": { "items": { "type": "string" }, "type": "array" }, "relatedTeamIds": { "items": { "type": "string" }, "type": "array" }, "removed": { "description": "Number of records removed.", "type": "boolean" }, "scheduledRoomDate": { "format": "date-time", "type": "string" }, "scheduledRoomId": { "type": [ "string", "null" ] }, "scheduledRoomName": { "type": "string" }, "scheduledRoomRef": { "type": "string" }, "tableId": { "type": "string" }, "tableName": { "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "competence", "corteId", "linkedCauses", "matchfound", "tableId", "tableName", "scheduledRoomId", "scheduledRoomRef", "scheduledRoomName", "scheduledRoomDate", "position", "caratulado", "partialRol", "createdAt", "updatedAt", "changedAt", "changedText", "removed", "relatedOrgIds", "relatedTeamIds" ], "type": "object" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "scheduledCauses", "pageCount", "total" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reference:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reference:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reference:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get scheduled causes", "tags": [ "Reference data" ], "x-required-scope": "reference:read" } }, "/api/actions/tablas/queries/get-scheduled-rooms": { "post": { "description": "Get scheduled rooms\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tablas-queries-get-scheduled-rooms", "requestBody": { "content": { "application/json": { "example": { "args": [ { "corteId": "", "from": "", "name": "", "page": 0, "per_page": 0, "relator": "", "sort": "", "tableName": "", "to": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "corteId": { "type": "string" }, "from": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "per_page": { "type": "number" }, "relator": { "type": "string" }, "sort": { "type": "string" }, "tableName": { "type": "string" }, "to": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "scheduledRooms": [ { "id": "string", "corteId": 0, "tableId": "string", "tableName": "string", "ref": "string", "name": "string", "date": "2026-01-31T12:00:00Z", "relator": "string", "members": [ { "job": "string", "name": "string" } ], "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "changedAt": "2026-01-31T12:00:00Z", "removed": true } ], "pageCount": 0, "total": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "scheduledRooms": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "corteId": { "description": "PJUD court of appeals id.", "type": "integer" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "date": { "description": "Date (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "members": { "description": "Members.", "items": { "properties": { "job": { "description": "Role in the room (ministro, abogado integrante...).", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "job", "name" ], "type": "object" }, "type": "array" }, "name": { "description": "Display name.", "type": "string" }, "ref": { "type": "string" }, "relator": { "type": "string" }, "removed": { "description": "Number of records removed.", "type": "boolean" }, "tableId": { "type": "string" }, "tableName": { "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "corteId", "tableId", "tableName", "ref", "name", "date", "relator", "members", "createdAt", "updatedAt", "changedAt", "removed" ], "type": "object" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "scheduledRooms", "pageCount", "total" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"reference:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"reference:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "reference:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get scheduled rooms", "tags": [ "Reference data" ], "x-required-scope": "reference:read" } }, "/api/actions/tasks/mutations/add-task-document": { "post": { "description": "Add task document\n\nAuthentication: developer API key. Required scope: `tasks:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tasks-mutations-add-task-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "documentId": "", "sourceId": "", "sourceType": "", "taskId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "documentId": { "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" }, "taskId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "document": { "id": "string", "sourceType": "string", "sourceId": "string", "path": "string", "fileName": "string", "label": "string", "causaId": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "document": { "properties": { "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "path": { "description": "Path relative to the API host.", "type": "string" }, "sourceId": { "description": "Id of the record in its source.", "type": "string" }, "sourceType": { "description": "Kind of source record.", "type": "string" } }, "required": [ "id", "sourceType", "sourceId", "path", "fileName", "label", "causaId" ], "type": "object" } }, "required": [ "document" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"tasks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"tasks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "tasks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add task document", "tags": [ "Tasks" ], "x-modifies-data": true, "x-required-scope": "tasks:write" } }, "/api/actions/tasks/mutations/create-task": { "post": { "description": "Create task\n\nAuthentication: developer API key. Required scope: `tasks:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tasks-mutations-create-task", "requestBody": { "content": { "application/json": { "example": { "args": [ { "assignedUserIds": [], "causaId": "", "description": "", "dueDate": "", "dueEnd": "", "id": "", "internalCauseId": "", "priority": "", "reviewerId": "", "sourceId": "", "sourceType": "", "status": "", "teamId": "", "title": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "assignedUserIds": { "items": { "type": "string" }, "type": "array" }, "causaId": { "type": "string" }, "description": { "type": "string" }, "dueDate": { "type": "string" }, "dueEnd": { "type": "string" }, "id": { "type": "string" }, "internalCauseId": { "type": "string" }, "priority": { "type": "string" }, "reviewerId": { "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" }, "status": { "type": "string" }, "teamId": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"tasks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"tasks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "tasks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create task", "tags": [ "Tasks" ], "x-modifies-data": true, "x-required-scope": "tasks:write" } }, "/api/actions/tasks/mutations/remove-task-document": { "post": { "description": "Remove task document\n\nAuthentication: developer API key. Required scope: `tasks:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tasks-mutations-remove-task-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "documentId": "", "sourceId": "", "sourceType": "", "taskId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "documentId": { "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" }, "taskId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "documentId": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "documentId": { "description": "Document id.", "type": "string" } }, "required": [ "documentId" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"tasks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"tasks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "tasks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove task document", "tags": [ "Tasks" ], "x-modifies-data": true, "x-required-scope": "tasks:write" } }, "/api/actions/tasks/mutations/update-task": { "post": { "description": "Update task\n\nAuthentication: developer API key. Required scope: `tasks:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tasks-mutations-update-task", "requestBody": { "content": { "application/json": { "example": { "args": [ { "assignedUserIds": [], "causaId": "", "description": "", "dueDate": "", "dueEnd": "", "id": "", "internalCauseId": "", "priority": "", "reviewerId": "", "sourceId": "", "sourceType": "", "status": "", "teamId": "", "title": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "assignedUserIds": { "items": { "type": "string" }, "type": "array" }, "causaId": { "type": "string" }, "description": { "type": "string" }, "dueDate": { "type": "string" }, "dueEnd": { "type": "string" }, "id": { "type": "string" }, "internalCauseId": { "type": "string" }, "priority": { "type": "string" }, "reviewerId": { "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" }, "status": { "type": "string" }, "teamId": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"tasks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"tasks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "tasks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update task", "tags": [ "Tasks" ], "x-modifies-data": true, "x-required-scope": "tasks:write" } }, "/api/actions/tasks/queries/get-cause-movement-documents": { "post": { "description": "Documents attached to a causa's movements (up to 60, newest first). args[0]: {causaId}.\n\nAuthentication: developer API key. Required scope: `tasks:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tasks-queries-get-cause-movement-documents", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "\u003cCASE_ID\u003e" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "documentId": { "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" }, "taskId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "documents": [ { "sourceType": "string", "sourceId": "string", "label": "string", "fileName": "string", "fecha": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "documents": { "description": "Documents.", "items": { "properties": { "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fileName": { "description": "Original file name.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "sourceId": { "description": "Id of the record in its source.", "type": "string" }, "sourceType": { "description": "Kind of source record.", "type": "string" } }, "required": [ "sourceType", "sourceId", "label", "fileName", "fecha" ], "type": "object" }, "type": "array" } }, "required": [ "documents" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"tasks:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"tasks:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "tasks:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get causa movement documents", "tags": [ "Tasks" ], "x-required-scope": "tasks:read" } }, "/api/actions/tasks/queries/get-task-documents": { "post": { "description": "Get task documents\n\nAuthentication: developer API key. Required scope: `tasks:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tasks-queries-get-task-documents", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "documentId": "", "sourceId": "", "sourceType": "", "taskId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "documentId": { "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" }, "taskId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "documents": [ { "id": "string", "sourceType": "string", "sourceId": "string", "path": "string", "fileName": "string", "label": "string", "causaId": "string", "createdAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "documents": { "description": "Documents.", "items": { "properties": { "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "path": { "description": "Path relative to the API host.", "type": "string" }, "sourceId": { "description": "Id of the record in its source.", "type": "string" }, "sourceType": { "description": "Kind of source record.", "type": "string" } }, "required": [ "id", "sourceType", "sourceId", "path", "fileName", "label", "causaId", "createdAt" ], "type": "object" }, "type": "array" } }, "required": [ "documents" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"tasks:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"tasks:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "tasks:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get task documents", "tags": [ "Tasks" ], "x-required-scope": "tasks:read" } }, "/api/actions/tasks/queries/get-tasks": { "post": { "description": "List the organization's tasks.\n\nAuthentication: developer API key. Required scope: `tasks:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tasks-queries-get-tasks", "requestBody": { "content": { "application/json": { "example": { "args": [ { "assigneeId": "", "closedFrom": "", "closedTo": "", "dueFrom": "", "dueTo": "", "page": 0, "perPage": 0, "priority": "", "reviewerId": "", "search": "", "sort": "", "status": "", "statuses": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "assigneeId": { "type": "string" }, "closedFrom": { "type": "string" }, "closedTo": { "type": "string" }, "dueFrom": { "type": "string" }, "dueTo": { "type": "string" }, "page": { "type": "number" }, "perPage": { "type": "number" }, "priority": { "type": "string" }, "reviewerId": { "type": "string" }, "search": { "type": "string" }, "sort": { "type": "string" }, "status": { "type": "string" }, "statuses": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "tasks": [ { "id": "string", "title": "string", "description": "string", "status": "string", "priority": "string", "dueDate": "2026-01-31T12:00:00Z", "dueEnd": "2026-01-31T12:00:00Z", "isCompleted": true, "completedAt": "2026-01-31T12:00:00Z", "orgId": "string", "teamId": "string", "causaId": "string", "internalCauseId": "string", "causaLabel": "string", "assignedUserIds": [ "string" ], "reviewerId": "string", "sortOrder": 0, "sourceType": "string", "sourceId": "string", "documents": [ { "id": "string", "sourceType": "string", "sourceId": "string", "path": "string", "fileName": "string", "label": "string" } ], "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "total": 0, "page": 0, "pageCount": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "page": { "description": "Current page number (1-based).", "type": "integer" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "tasks": { "items": { "properties": { "assignedUserIds": { "description": "Ids of the users it is assigned to.", "items": { "type": "string" }, "type": "array" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "causaLabel": { "type": "string" }, "completedAt": { "description": "When it finished (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "description": { "description": "Free-text description.", "type": [ "string", "null" ] }, "documents": { "description": "Documents attached to the task, oldest first.", "items": { "properties": { "fileName": { "description": "Original file name.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "path": { "description": "Storage path.", "type": "string" }, "sourceId": { "description": "Id of the record in its source.", "type": "string" }, "sourceType": { "description": "Where the document comes from.", "type": "string" } }, "required": [ "id", "sourceType", "sourceId", "path", "fileName", "label" ], "type": "object" }, "type": "array" }, "dueDate": { "description": "Due date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "dueEnd": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "internalCauseId": { "description": "Expediente (internal case) id.", "type": [ "string", "null" ] }, "isCompleted": { "type": "boolean" }, "orgId": { "description": "Organization id.", "type": "string" }, "priority": { "type": "string" }, "reviewerId": { "type": [ "string", "null" ] }, "sortOrder": { "type": "integer" }, "sourceId": { "description": "Id of the record in its source.", "type": [ "string", "null" ] }, "sourceType": { "description": "Kind of source record.", "type": [ "string", "null" ] }, "status": { "description": "Current status.", "type": "string" }, "teamId": { "type": [ "string", "null" ] }, "title": { "description": "Title.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "description", "status", "priority", "dueDate", "dueEnd", "isCompleted", "completedAt", "orgId", "teamId", "causaId", "internalCauseId", "causaLabel", "assignedUserIds", "reviewerId", "sortOrder", "sourceType", "sourceId", "documents", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "tasks", "total" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"tasks:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"tasks:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "tasks:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tasks", "tags": [ "Tasks" ], "x-required-scope": "tasks:read" } }, "/api/actions/tasks/review/get-task-events": { "post": { "description": "Get task events\n\nAuthentication: developer API key. Required scope: `tasks:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tasks-review-get-task-events", "requestBody": { "content": { "application/json": { "example": { "args": [ { "taskId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "taskId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "events": [ { "id": "string", "type": "string", "from": "string", "to": "string", "payload": {}, "createdAt": "2026-01-31T12:00:00Z", "actorId": "string", "actorName": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "events": { "description": "Events, newest first.", "items": { "properties": { "actorId": { "description": "Id of the user who performed the action.", "type": "string" }, "actorName": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "from": { "description": "Start of the range (ISO 8601).", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "payload": { "description": "Event detail as stored (comment text, review decision, ...); its keys depend on the event type; null when none." }, "to": { "description": "End of the range (ISO 8601).", "type": "string" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "type", "from", "to", "payload", "createdAt", "actorId", "actorName" ], "type": "object" }, "type": "array" } }, "required": [ "events" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"tasks:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"tasks:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "tasks:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get task events", "tags": [ "Tasks" ], "x-required-scope": "tasks:read" } }, "/api/actions/tc/mutations/mark-reviewed": { "post": { "description": "Mark reviewed\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tc-mutations-mark-reviewed", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "reviewed": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "reviewed": { "description": "Always true.", "type": "boolean" } }, "required": [ "reviewed" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark reviewed", "tags": [ "Constitutional Court" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tc/mutations/refresh": { "post": { "description": "Refresh\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tc-mutations-refresh", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "rol": "string", "status": "AVAILABLE" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "rol": { "description": "Canonical rol.", "type": "string" }, "status": { "description": "Absent when a newer stored copy already existed and this fetch was discarded.", "enum": [ "AVAILABLE", "INCOMPLETE" ], "type": "string" } }, "required": [ "id", "rol" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Refresh", "tags": [ "Constitutional Court" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tc/mutations/set-active": { "post": { "description": "Set active\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tc-mutations-set-active", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "active": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" } }, "required": [ "active" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set active", "tags": [ "Constitutional Court" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tc/mutations/upsert": { "post": { "description": "Upsert\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tc-mutations-upsert", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "rol": "string", "status": "AVAILABLE" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "rol": { "description": "Canonical rol.", "type": "string" }, "status": { "description": "Absent when a newer stored copy already existed and this fetch was discarded.", "enum": [ "AVAILABLE", "INCOMPLETE" ], "type": "string" } }, "required": [ "id", "rol" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upsert", "tags": [ "Constitutional Court" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tc/queries/detail": { "post": { "description": "Detail\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tc-queries-detail", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "case": { "id": "string", "rol": "string", "caratulado": "string", "active": true, "status": "string", "lastError": "string", "filedAt": "2026-01-31T12:00:00Z", "lastFetchedAt": "2026-01-31T12:00:00Z", "lastViewedAt": "2026-01-31T12:00:00Z", "snapshot": { "externalId": 0, "orderId": 0, "rol": "string", "caratulado": "string", "filedAt": "2026-01-31T12:00:00Z", "warnings": [ "string" ], "notebooks": [ { "id": "string", "name": "string", "stage": "string", "status": "string" } ], "parties": [ { "id": "string", "name": "string", "role": "string" } ], "movements": [ { "id": "string", "notebookId": "string", "type": "string", "reference": "string", "date": "string", "stage": "string", "documentId": "string", "reserved": true, "firstSeenAt": "2026-01-31T12:00:00Z" } ], "documents": [ { "id": "string", "name": "string", "type": "string", "notebookId": "string", "availability": "UNKNOWN" } ] }, "movements": [ { "id": "string", "notebookId": "string", "type": "string", "reference": "string", "date": "string", "stage": "string", "documentId": "string", "reserved": true, "firstSeenAt": "2026-01-31T12:00:00Z" } ], "documents": [ { "id": "string", "name": "string", "type": "string", "notebookId": "string", "availability": "UNKNOWN" } ], "parties": [ { "id": "string", "name": "string", "role": "string" } ] }, "canArchive": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canArchive": { "description": "The caller may call set-active.", "type": "boolean" }, "case": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "documents": { "description": "Documents.", "items": { "properties": { "availability": { "description": "UNAVAILABLE documents are reserved and cannot be downloaded.", "enum": [ "UNKNOWN", "UNAVAILABLE" ], "type": "string" }, "id": { "description": "Portal document id; pass it as documentId to the document query.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "notebookId": { "description": "Empty for case certificates.", "type": "string" }, "type": { "description": "Always application/pdf.", "type": "string" } }, "required": [ "id", "name", "type", "notebookId", "availability" ], "type": "object" }, "type": "array" }, "filedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": [ "string", "null" ] }, "lastFetchedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json); send it back as lastFetchedAt to mark-reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "lastViewedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json).", "format": "date-time", "type": [ "string", "null" ] }, "movements": { "items": { "properties": { "date": { "description": "Date exactly as the portal sends it.", "type": "string" }, "documentId": { "description": "Portal document id, empty when the movement has none.", "type": "string" }, "firstSeenAt": { "description": "When Nexulex first saw the movement (RFC 3339).", "format": "date-time", "type": "string" }, "id": { "description": "Stable key notebook:tramite:escrito:documento.", "type": "string" }, "notebookId": { "type": "string" }, "reference": { "type": "string" }, "reserved": { "description": "Tribunal Constitucional only: the movement is reserved.", "type": "boolean" }, "stage": { "type": "string" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "notebookId", "type", "reference", "date", "stage", "documentId", "firstSeenAt" ], "type": "object" }, "type": "array" }, "parties": { "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "role": { "description": "Role.", "type": "string" } }, "required": [ "id", "name", "role" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "snapshot": { "description": "The whole portal snapshot as of lastFetchedAt.", "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "documents": { "description": "Documents.", "items": { "properties": { "availability": { "description": "UNAVAILABLE documents are reserved and cannot be downloaded.", "enum": [ "UNKNOWN", "UNAVAILABLE" ], "type": "string" }, "id": { "description": "Portal document id; pass it as documentId to the document query.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "notebookId": { "description": "Empty for case certificates.", "type": "string" }, "type": { "description": "Always application/pdf.", "type": "string" } }, "required": [ "id", "name", "type", "notebookId", "availability" ], "type": "object" }, "type": "array" }, "externalId": { "type": "integer" }, "filedAt": { "format": "date-time", "type": [ "string", "null" ] }, "movements": { "items": { "properties": { "date": { "description": "Date exactly as the portal sends it.", "type": "string" }, "documentId": { "description": "Portal document id, empty when the movement has none.", "type": "string" }, "firstSeenAt": { "description": "When Nexulex first saw the movement (RFC 3339).", "format": "date-time", "type": "string" }, "id": { "description": "Stable key notebook:tramite:escrito:documento.", "type": "string" }, "notebookId": { "type": "string" }, "reference": { "type": "string" }, "reserved": { "description": "Tribunal Constitucional only: the movement is reserved.", "type": "boolean" }, "stage": { "type": "string" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "notebookId", "type", "reference", "date", "stage", "documentId", "firstSeenAt" ], "type": "object" }, "type": "array" }, "notebooks": { "description": "Cuadernos (case-file notebooks).", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "stage": { "type": "string" }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "id", "name", "stage", "status" ], "type": "object" }, "type": "array" }, "orderId": { "type": "integer" }, "parties": { "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "role": { "description": "Role.", "type": "string" } }, "required": [ "id", "name", "role" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "warnings": { "description": "Parts of the expediente the portal failed to deliver.", "items": { "type": "string" }, "type": "array" } }, "required": [ "externalId", "orderId", "rol", "caratulado", "filedAt", "warnings", "notebooks", "parties", "movements", "documents" ], "type": [ "object", "null" ] }, "status": { "description": "NOT_QUERIED, AVAILABLE, INCOMPLETE, or the last portal failure code.", "type": "string" } }, "required": [ "id", "rol", "caratulado", "active", "status", "lastError", "filedAt", "lastFetchedAt", "lastViewedAt", "snapshot", "movements", "documents", "parties" ], "type": "object" } }, "required": [ "case", "canArchive" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Detail", "tags": [ "Constitutional Court" ], "x-required-scope": "integrations:read" } }, "/api/actions/tc/queries/document": { "post": { "description": "Document\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tc-queries-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "name": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "name": { "description": "Display name.", "type": "string" }, "url": { "description": "Short-lived signed URL of the PDF.", "format": "uri", "type": "string" } }, "required": [ "url", "name" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Document", "tags": [ "Constitutional Court" ], "x-required-scope": "integrations:read" } }, "/api/actions/tc/queries/list": { "post": { "description": "List\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tc-queries-list", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "id": "string", "rol": "string", "caratulado": "string", "active": true, "status": "string", "lastError": "string", "lastFetchedAt": "2026-01-31T12:00:00Z", "lastViewedAt": "2026-01-31T12:00:00Z", "movementCount": 0, "newCount": 0 } ], "total": 0, "page": 0, "pageSize": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "page": { "description": "Current page number (1-based).", "type": "integer" }, "pageSize": { "description": "Always 50.", "type": "integer" }, "rows": { "description": "The records on this page.", "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": [ "string", "null" ] }, "lastFetchedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json).", "format": "date-time", "type": [ "string", "null" ] }, "lastViewedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json).", "format": "date-time", "type": [ "string", "null" ] }, "movementCount": { "type": "integer" }, "newCount": { "description": "Movements first seen after lastViewedAt (all of them when never reviewed).", "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "status": { "description": "NOT_QUERIED, AVAILABLE, INCOMPLETE, or the last portal failure code.", "type": "string" } }, "required": [ "id", "rol", "caratulado", "active", "status", "lastError", "lastFetchedAt", "lastViewedAt", "movementCount", "newCount" ], "type": "object" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "rows", "total", "page", "pageSize" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List", "tags": [ "Constitutional Court" ], "x-required-scope": "integrations:read" } }, "/api/actions/tc/queries/search": { "post": { "description": "Search\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tc-queries-search", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "externalId": 0, "orderId": 0, "rol": "string", "caratulado": "string", "procedureId": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "rows": { "description": "The records on this page.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "externalId": { "description": "Portal case id.", "type": "integer" }, "orderId": { "description": "Portal work-order id.", "type": "integer" }, "procedureId": { "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "externalId", "orderId", "rol", "caratulado", "procedureId" ], "type": "object" }, "type": "array" } }, "required": [ "rows" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search", "tags": [ "Constitutional Court" ], "x-required-scope": "integrations:read" } }, "/api/actions/tcp/mutations/mark-reviewed": { "post": { "description": "Mark reviewed\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tcp-mutations-mark-reviewed", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "reviewed": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "reviewed": { "description": "Always true.", "type": "boolean" } }, "required": [ "reviewed" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark reviewed", "tags": [ "Public Procurement Court" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tcp/mutations/refresh": { "post": { "description": "Refresh\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tcp-mutations-refresh", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "rol": "string", "status": "AVAILABLE" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "rol": { "description": "Canonical rol.", "type": "string" }, "status": { "description": "Absent when a newer stored copy already existed and this fetch was discarded.", "enum": [ "AVAILABLE", "INCOMPLETE" ], "type": "string" } }, "required": [ "id", "rol" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Refresh", "tags": [ "Public Procurement Court" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tcp/mutations/set-active": { "post": { "description": "Set active\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tcp-mutations-set-active", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "active": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" } }, "required": [ "active" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set active", "tags": [ "Public Procurement Court" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tcp/mutations/upsert": { "post": { "description": "Upsert\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tcp-mutations-upsert", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "rol": "string", "status": "AVAILABLE" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "rol": { "description": "Canonical rol.", "type": "string" }, "status": { "description": "Absent when a newer stored copy already existed and this fetch was discarded.", "enum": [ "AVAILABLE", "INCOMPLETE" ], "type": "string" } }, "required": [ "id", "rol" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upsert", "tags": [ "Public Procurement Court" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tcp/queries/detail": { "post": { "description": "Detail\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tcp-queries-detail", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "case": { "id": "string", "rol": "string", "caratulado": "string", "active": true, "status": "string", "lastError": "string", "filedAt": "2026-01-31T12:00:00Z", "lastFetchedAt": "2026-01-31T12:00:00Z", "lastViewedAt": "2026-01-31T12:00:00Z", "snapshot": { "externalId": 0, "orderId": 0, "rol": "string", "caratulado": "string", "filedAt": "2026-01-31T12:00:00Z", "warnings": [ "string" ], "notebooks": [ { "id": "string", "name": "string", "stage": "string", "status": "string" } ], "parties": [ { "id": "string", "name": "string", "role": "string" } ], "movements": [ { "id": "string", "notebookId": "string", "type": "string", "reference": "string", "date": "string", "stage": "string", "documentId": "string", "reserved": true, "firstSeenAt": "2026-01-31T12:00:00Z" } ], "documents": [ { "id": "string", "name": "string", "type": "string", "notebookId": "string", "availability": "UNKNOWN" } ] }, "movements": [ { "id": "string", "notebookId": "string", "type": "string", "reference": "string", "date": "string", "stage": "string", "documentId": "string", "reserved": true, "firstSeenAt": "2026-01-31T12:00:00Z" } ], "documents": [ { "id": "string", "name": "string", "type": "string", "notebookId": "string", "availability": "UNKNOWN" } ], "parties": [ { "id": "string", "name": "string", "role": "string" } ] }, "canArchive": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canArchive": { "description": "The caller may call set-active.", "type": "boolean" }, "case": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "documents": { "description": "Documents.", "items": { "properties": { "availability": { "description": "UNAVAILABLE documents are reserved and cannot be downloaded.", "enum": [ "UNKNOWN", "UNAVAILABLE" ], "type": "string" }, "id": { "description": "Portal document id; pass it as documentId to the document query.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "notebookId": { "description": "Empty for case certificates.", "type": "string" }, "type": { "description": "Always application/pdf.", "type": "string" } }, "required": [ "id", "name", "type", "notebookId", "availability" ], "type": "object" }, "type": "array" }, "filedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": [ "string", "null" ] }, "lastFetchedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json); send it back as lastFetchedAt to mark-reviewed.", "format": "date-time", "type": [ "string", "null" ] }, "lastViewedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json).", "format": "date-time", "type": [ "string", "null" ] }, "movements": { "items": { "properties": { "date": { "description": "Date exactly as the portal sends it.", "type": "string" }, "documentId": { "description": "Portal document id, empty when the movement has none.", "type": "string" }, "firstSeenAt": { "description": "When Nexulex first saw the movement (RFC 3339).", "format": "date-time", "type": "string" }, "id": { "description": "Stable key notebook:tramite:escrito:documento.", "type": "string" }, "notebookId": { "type": "string" }, "reference": { "type": "string" }, "reserved": { "description": "Tribunal Constitucional only: the movement is reserved.", "type": "boolean" }, "stage": { "type": "string" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "notebookId", "type", "reference", "date", "stage", "documentId", "firstSeenAt" ], "type": "object" }, "type": "array" }, "parties": { "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "role": { "description": "Role.", "type": "string" } }, "required": [ "id", "name", "role" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "snapshot": { "description": "The whole portal snapshot as of lastFetchedAt.", "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "documents": { "description": "Documents.", "items": { "properties": { "availability": { "description": "UNAVAILABLE documents are reserved and cannot be downloaded.", "enum": [ "UNKNOWN", "UNAVAILABLE" ], "type": "string" }, "id": { "description": "Portal document id; pass it as documentId to the document query.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "notebookId": { "description": "Empty for case certificates.", "type": "string" }, "type": { "description": "Always application/pdf.", "type": "string" } }, "required": [ "id", "name", "type", "notebookId", "availability" ], "type": "object" }, "type": "array" }, "externalId": { "type": "integer" }, "filedAt": { "format": "date-time", "type": [ "string", "null" ] }, "movements": { "items": { "properties": { "date": { "description": "Date exactly as the portal sends it.", "type": "string" }, "documentId": { "description": "Portal document id, empty when the movement has none.", "type": "string" }, "firstSeenAt": { "description": "When Nexulex first saw the movement (RFC 3339).", "format": "date-time", "type": "string" }, "id": { "description": "Stable key notebook:tramite:escrito:documento.", "type": "string" }, "notebookId": { "type": "string" }, "reference": { "type": "string" }, "reserved": { "description": "Tribunal Constitucional only: the movement is reserved.", "type": "boolean" }, "stage": { "type": "string" }, "type": { "description": "Record type.", "type": "string" } }, "required": [ "id", "notebookId", "type", "reference", "date", "stage", "documentId", "firstSeenAt" ], "type": "object" }, "type": "array" }, "notebooks": { "description": "Cuadernos (case-file notebooks).", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "stage": { "type": "string" }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "id", "name", "stage", "status" ], "type": "object" }, "type": "array" }, "orderId": { "type": "integer" }, "parties": { "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "role": { "description": "Role.", "type": "string" } }, "required": [ "id", "name", "role" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "warnings": { "description": "Parts of the expediente the portal failed to deliver.", "items": { "type": "string" }, "type": "array" } }, "required": [ "externalId", "orderId", "rol", "caratulado", "filedAt", "warnings", "notebooks", "parties", "movements", "documents" ], "type": [ "object", "null" ] }, "status": { "description": "NOT_QUERIED, AVAILABLE, INCOMPLETE, or the last portal failure code.", "type": "string" } }, "required": [ "id", "rol", "caratulado", "active", "status", "lastError", "filedAt", "lastFetchedAt", "lastViewedAt", "snapshot", "movements", "documents", "parties" ], "type": "object" } }, "required": [ "case", "canArchive" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Detail", "tags": [ "Public Procurement Court" ], "x-required-scope": "integrations:read" } }, "/api/actions/tcp/queries/document": { "post": { "description": "Document\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tcp-queries-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "name": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "name": { "description": "Display name.", "type": "string" }, "url": { "description": "Short-lived signed URL of the PDF.", "format": "uri", "type": "string" } }, "required": [ "url", "name" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Document", "tags": [ "Public Procurement Court" ], "x-required-scope": "integrations:read" } }, "/api/actions/tcp/queries/list": { "post": { "description": "List\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tcp-queries-list", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "id": "string", "rol": "string", "caratulado": "string", "active": true, "status": "string", "lastError": "string", "lastFetchedAt": "2026-01-31T12:00:00Z", "lastViewedAt": "2026-01-31T12:00:00Z", "movementCount": 0, "newCount": 0 } ], "total": 0, "page": 0, "pageSize": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "page": { "description": "Current page number (1-based).", "type": "integer" }, "pageSize": { "description": "Always 50.", "type": "integer" }, "rows": { "description": "The records on this page.", "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": [ "string", "null" ] }, "lastFetchedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json).", "format": "date-time", "type": [ "string", "null" ] }, "lastViewedAt": { "description": "Timestamp without a UTC offset (a timestamp(3) column read through row_to_json).", "format": "date-time", "type": [ "string", "null" ] }, "movementCount": { "type": "integer" }, "newCount": { "description": "Movements first seen after lastViewedAt (all of them when never reviewed).", "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "status": { "description": "NOT_QUERIED, AVAILABLE, INCOMPLETE, or the last portal failure code.", "type": "string" } }, "required": [ "id", "rol", "caratulado", "active", "status", "lastError", "lastFetchedAt", "lastViewedAt", "movementCount", "newCount" ], "type": "object" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "rows", "total", "page", "pageSize" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List", "tags": [ "Public Procurement Court" ], "x-required-scope": "integrations:read" } }, "/api/actions/tcp/queries/search": { "post": { "description": "Search\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tcp-queries-search", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "documentId": "", "id": "", "lastFetchedAt": "", "page": 0, "rol": "", "search": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "documentId": { "type": "string" }, "id": { "type": "string" }, "lastFetchedAt": { "type": "string" }, "page": { "type": "number" }, "rol": { "type": "string" }, "search": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "rows": [ { "externalId": 0, "orderId": 0, "rol": "string", "caratulado": "string", "procedureId": 0 } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "rows": { "description": "The records on this page.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "externalId": { "description": "Portal case id.", "type": "integer" }, "orderId": { "description": "Portal work-order id.", "type": "integer" }, "procedureId": { "type": "integer" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" } }, "required": [ "externalId", "orderId", "rol", "caratulado", "procedureId" ], "type": "object" }, "type": "array" } }, "required": [ "rows" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search", "tags": [ "Public Procurement Court" ], "x-required-scope": "integrations:read" } }, "/api/actions/time/tracker/assign-timer": { "post": { "description": "Assign the key owner's open timer to a client, cause, internal case, or task.\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-assign-timer", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "clientId": "", "internalCauseId": "", "taskId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "clientId": { "type": "string" }, "internalCauseId": { "type": "string" }, "taskId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Assign timer", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/time/tracker/delete-time-entry": { "post": { "description": "Delete time entry\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-delete-time-entry", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete time entry", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/time/tracker/export-time-entries": { "post": { "description": "Export time entries\n\nAuthentication: developer API key. Required scope: `time:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-export-time-entries", "requestBody": { "content": { "application/json": { "example": { "args": [ { "billable": "", "causaId": "", "clientId": "", "format": "", "from": "", "internalCauseId": "", "locale": "", "to": "", "userId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "billable": { "type": "string" }, "causaId": { "type": "string" }, "clientId": { "type": "string" }, "format": { "type": "string" }, "from": { "type": "string" }, "internalCauseId": { "type": "string" }, "locale": { "type": "string" }, "to": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "filename": "string", "base64": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "base64": { "type": "string" }, "filename": { "type": "string" } }, "required": [ "filename", "base64" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Export time entries", "tags": [ "Time and billing" ], "x-required-scope": "time:read" } }, "/api/actions/time/tracker/get-running-timer": { "post": { "description": "The key owner's running timer, if any.\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-get-running-timer", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "timer": { "id": "string", "legacy": true, "userId": "string", "userName": "string", "clientId": "string", "clientName": "string", "causaId": "string", "causaLabel": "string", "internalCauseId": "string", "internalCauseLabel": "string", "taskId": "string", "startedAt": "2026-01-31T12:00:00Z", "accumulatedSeconds": 0, "activeSince": "2026-01-31T12:00:00Z", "pausedAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "minutes": 0, "description": "string", "billable": true, "hourlyRate": 0, "currency": "string", "source": "string", "billingNoteId": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "timer": { "properties": { "accumulatedSeconds": { "type": "integer" }, "activeSince": { "format": "date-time", "type": [ "string", "null" ] }, "billable": { "description": "Whether the time is billable.", "type": "boolean" }, "billingNoteId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "causaLabel": { "type": "string" }, "clientId": { "description": "Client id.", "type": "string" }, "clientName": { "type": "string" }, "currency": { "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "hourlyRate": { "type": [ "number", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "internalCauseId": { "description": "Expediente (internal case) id.", "type": "string" }, "internalCauseLabel": { "type": "string" }, "legacy": { "type": "boolean" }, "minutes": { "description": "Minutes.", "type": "integer" }, "pausedAt": { "format": "date-time", "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "userId": { "description": "User id.", "type": "string" }, "userName": { "type": "string" } }, "required": [ "id", "legacy", "userId", "userName", "clientId", "clientName", "causaId", "causaLabel", "internalCauseId", "internalCauseLabel", "taskId", "startedAt", "accumulatedSeconds", "activeSince", "pausedAt", "endedAt", "minutes", "description", "billable", "hourlyRate", "currency", "source", "billingNoteId" ], "type": [ "object", "null" ] } }, "required": [ "timer" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get running timer", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/time/tracker/get-time-reports": { "post": { "description": "Get time reports\n\nAuthentication: developer API key. Required scope: `time:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-get-time-reports", "requestBody": { "content": { "application/json": { "example": { "args": [ { "billable": "", "causaId": "", "clientId": "", "format": "", "from": "", "internalCauseId": "", "locale": "", "to": "", "userId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "billable": { "type": "string" }, "causaId": { "type": "string" }, "clientId": { "type": "string" }, "format": { "type": "string" }, "from": { "type": "string" }, "internalCauseId": { "type": "string" }, "locale": { "type": "string" }, "to": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "from": "string", "to": "string", "byDay": [ { "key": "string", "label": "string", "minutes": 0, "billableMinutes": 0 } ], "byUser": [ { "key": "string", "label": "string", "minutes": 0, "billableMinutes": 0 } ], "byClient": [ { "key": "string", "label": "string", "minutes": 0, "billableMinutes": 0 } ], "topCausas": [ { "key": "string", "label": "string", "minutes": 0, "billableMinutes": 0 } ], "totals": { "minutes": 0, "billableMinutes": 0 }, "viewAll": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "byClient": { "description": "Top 50 clients by minutes.", "items": { "properties": { "billableMinutes": { "description": "Billable minutes.", "type": "integer" }, "key": { "description": "Client id; empty for entries without a client.", "type": "string" }, "label": { "description": "Client name.", "type": "string" }, "minutes": { "description": "Minutes.", "type": "integer" } }, "required": [ "key", "label", "minutes", "billableMinutes" ], "type": "object" }, "type": "array" }, "byDay": { "description": "Finished entries per day (up to 400 days).", "items": { "properties": { "billableMinutes": { "description": "Billable minutes.", "type": "integer" }, "key": { "description": "Day, YYYY-MM-DD in Chile time.", "type": "string" }, "label": { "description": "Always empty.", "type": "string" }, "minutes": { "description": "Minutes.", "type": "integer" } }, "required": [ "key", "label", "minutes", "billableMinutes" ], "type": "object" }, "type": "array" }, "byUser": { "description": "Top 100 users by minutes.", "items": { "properties": { "billableMinutes": { "description": "Billable minutes.", "type": "integer" }, "key": { "description": "User id.", "type": "string" }, "label": { "description": "User name or email.", "type": "string" }, "minutes": { "description": "Minutes.", "type": "integer" } }, "required": [ "key", "label", "minutes", "billableMinutes" ], "type": "object" }, "type": "array" }, "from": { "description": "Start of the range (ISO 8601).", "type": "string" }, "to": { "description": "End of the range (ISO 8601).", "type": "string" }, "topCausas": { "description": "Top 10 causas/expedientes by minutes.", "items": { "properties": { "billableMinutes": { "description": "Billable minutes.", "type": "integer" }, "key": { "description": "Causa or expediente id; empty for entries linked to neither.", "type": "string" }, "label": { "description": "\"rol · carátula\" of the causa or expediente.", "type": "string" }, "minutes": { "description": "Minutes.", "type": "integer" } }, "required": [ "key", "label", "minutes", "billableMinutes" ], "type": "object" }, "type": "array" }, "totals": { "properties": { "billableMinutes": { "description": "Billable minutes.", "type": "integer" }, "minutes": { "description": "Minutes.", "type": "integer" } }, "required": [ "minutes", "billableMinutes" ], "type": "object" }, "viewAll": { "type": "boolean" } }, "required": [ "from", "to", "byDay", "byUser", "byClient", "topCausas", "totals", "viewAll" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get time reports", "tags": [ "Time and billing" ], "x-required-scope": "time:read" } }, "/api/actions/time/tracker/get-timer-assignment-options": { "post": { "description": "Get timer assignment options\n\nAuthentication: developer API key. Required scope: `time:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-get-timer-assignment-options", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "clients": [ { "id": "string", "label": "string" } ], "causas": [ { "id": "string", "label": "string" } ], "internalCauses": [ { "id": "string", "label": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causas": { "description": "Active organization causas (latest 400); label is \"rol · carátula\".", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "clients": { "description": "Organization clients (up to 1000).", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "internalCauses": { "description": "Expedientes (latest 400); label is \"rol · name\".", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" } }, "required": [ "clients", "causas", "internalCauses" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get timer assignment options", "tags": [ "Time and billing" ], "x-required-scope": "time:read" } }, "/api/actions/time/tracker/import-hearing": { "post": { "description": "Import hearing\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-import-hearing", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "locale": "", "minutes": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "locale": { "type": "string" }, "minutes": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Import hearing", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/time/tracker/list-time-entries": { "post": { "description": "List time entries with filters (from, to, clientId, causaId, billable) and totals.\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-list-time-entries", "requestBody": { "content": { "application/json": { "example": { "args": [ { "billable": "", "causaId": "", "clientId": "", "format": "", "from": "", "internalCauseId": "", "locale": "", "to": "", "userId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "billable": { "type": "string" }, "causaId": { "type": "string" }, "clientId": { "type": "string" }, "format": { "type": "string" }, "from": { "type": "string" }, "internalCauseId": { "type": "string" }, "locale": { "type": "string" }, "to": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "entries": [ { "id": "string", "legacy": true, "userId": "string", "userName": "string", "clientId": "string", "clientName": "string", "causaId": "string", "causaLabel": "string", "internalCauseId": "string", "internalCauseLabel": "string", "taskId": "string", "startedAt": "2026-01-31T12:00:00Z", "accumulatedSeconds": 0, "activeSince": "2026-01-31T12:00:00Z", "pausedAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "minutes": 0, "description": "string", "billable": true, "hourlyRate": 0, "currency": "string", "source": "string", "billingNoteId": "string" } ], "totals": { "minutes": 0, "billableMinutes": 0, "entries": 0 }, "running": { "id": "string", "legacy": true, "userId": "string", "userName": "string", "clientId": "string", "clientName": "string", "causaId": "string", "causaLabel": "string", "internalCauseId": "string", "internalCauseLabel": "string", "taskId": "string", "startedAt": "2026-01-31T12:00:00Z", "accumulatedSeconds": 0, "activeSince": "2026-01-31T12:00:00Z", "pausedAt": "2026-01-31T12:00:00Z", "endedAt": "2026-01-31T12:00:00Z", "minutes": 0, "description": "string", "billable": true, "hourlyRate": 0, "currency": "string", "source": "string", "billingNoteId": "string" }, "options": { "clients": [ { "id": "string", "label": "string" } ], "causas": [ { "id": "string", "label": "string" } ], "internalCauses": [ { "id": "string", "label": "string" } ], "users": [ { "id": "string", "label": "string" } ], "viewAll": true, "userId": "string" }, "hearings": [ { "id": "string", "causaId": "string", "label": "string", "kind": "string", "kindEs": "string", "kindEn": "string", "startsAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "entries": { "description": "Entries.", "items": { "properties": { "accumulatedSeconds": { "type": "integer" }, "activeSince": { "format": "date-time", "type": [ "string", "null" ] }, "billable": { "description": "Whether the time is billable.", "type": "boolean" }, "billingNoteId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "causaLabel": { "type": "string" }, "clientId": { "description": "Client id.", "type": "string" }, "clientName": { "type": "string" }, "currency": { "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "hourlyRate": { "type": [ "number", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "internalCauseId": { "description": "Expediente (internal case) id.", "type": "string" }, "internalCauseLabel": { "type": "string" }, "legacy": { "type": "boolean" }, "minutes": { "description": "Minutes.", "type": "integer" }, "pausedAt": { "format": "date-time", "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "userId": { "description": "User id.", "type": "string" }, "userName": { "type": "string" } }, "required": [ "id", "legacy", "userId", "userName", "clientId", "clientName", "causaId", "causaLabel", "internalCauseId", "internalCauseLabel", "taskId", "startedAt", "accumulatedSeconds", "activeSince", "pausedAt", "endedAt", "minutes", "description", "billable", "hourlyRate", "currency", "source", "billingNoteId" ], "type": "object" }, "type": "array" }, "hearings": { "items": { "properties": { "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "kindEn": { "type": "string" }, "kindEs": { "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "startsAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "causaId", "label", "kind", "kindEs", "kindEn", "startsAt" ], "type": "object" }, "type": "array" }, "options": { "description": "Available options.", "properties": { "causas": { "description": "Active organization causas (latest 400); label is \"rol · carátula\".", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "clients": { "description": "Organization clients (up to 1000).", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "internalCauses": { "description": "Expedientes (latest 400); label is \"rol · name\".", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "userId": { "description": "The caller's user id.", "type": "string" }, "users": { "description": "Organization members; empty unless the caller can view everyone's time.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" } }, "required": [ "id", "label" ], "type": "object" }, "type": "array" }, "viewAll": { "description": "Whether the caller can view everyone's time.", "type": "boolean" } }, "required": [ "clients", "causas", "internalCauses", "users", "viewAll", "userId" ], "type": "object" }, "running": { "properties": { "accumulatedSeconds": { "type": "integer" }, "activeSince": { "format": "date-time", "type": [ "string", "null" ] }, "billable": { "description": "Whether the time is billable.", "type": "boolean" }, "billingNoteId": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "causaLabel": { "type": "string" }, "clientId": { "description": "Client id.", "type": "string" }, "clientName": { "type": "string" }, "currency": { "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "endedAt": { "description": "When it ended (ISO 8601); null while ongoing.", "format": "date-time", "type": [ "string", "null" ] }, "hourlyRate": { "type": [ "number", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "internalCauseId": { "description": "Expediente (internal case) id.", "type": "string" }, "internalCauseLabel": { "type": "string" }, "legacy": { "type": "boolean" }, "minutes": { "description": "Minutes.", "type": "integer" }, "pausedAt": { "format": "date-time", "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "type": "string" }, "startedAt": { "description": "When it started (ISO 8601).", "format": "date-time", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "userId": { "description": "User id.", "type": "string" }, "userName": { "type": "string" } }, "required": [ "id", "legacy", "userId", "userName", "clientId", "clientName", "causaId", "causaLabel", "internalCauseId", "internalCauseLabel", "taskId", "startedAt", "accumulatedSeconds", "activeSince", "pausedAt", "endedAt", "minutes", "description", "billable", "hourlyRate", "currency", "source", "billingNoteId" ], "type": "object" }, "totals": { "properties": { "billableMinutes": { "description": "Billable minutes.", "type": "integer" }, "entries": { "description": "Entries.", "type": "integer" }, "minutes": { "description": "Minutes.", "type": "integer" } }, "required": [ "minutes", "billableMinutes", "entries" ], "type": "object" } }, "required": [ "entries", "totals", "running", "options", "hearings" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List time entries", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/time/tracker/pause-timer": { "post": { "description": "Pause the key owner's timer and preserve accumulated time.\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-pause-timer", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Pause timer", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/time/tracker/resume-timer": { "post": { "description": "Resume the key owner's paused timer.\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-resume-timer", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Resume timer", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/time/tracker/save-time-entry": { "post": { "description": "Log or edit a time entry (date YYYY-MM-DD, start HH:MM, minutes, description, links).\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-save-time-entry", "requestBody": { "content": { "application/json": { "example": { "args": [ { "billable": false, "causaId": "", "clientId": "", "currency": "", "date": "", "description": "", "hourlyRate": 0, "id": "", "internalCauseId": "", "minutes": 0, "start": "", "taskId": "", "userId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "billable": { "type": "boolean" }, "causaId": { "type": "string" }, "clientId": { "type": "string" }, "currency": { "type": "string" }, "date": { "type": "string" }, "description": { "type": "string" }, "hourlyRate": { "type": "number" }, "id": { "type": "string" }, "internalCauseId": { "type": "string" }, "minutes": { "type": "number" }, "start": { "type": "string" }, "taskId": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save time entry", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/time/tracker/start-timer": { "post": { "description": "Start a timer for the key owner; fails when a timer is already open. args[0]: description, clientId, causaId, internalCauseId, billable; send source DESKTOP.\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-start-timer", "requestBody": { "content": { "application/json": { "example": { "args": [ { "billable": false, "causaId": "", "clientId": "", "description": "", "internalCauseId": "", "source": "", "taskId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "billable": { "type": "boolean" }, "causaId": { "type": "string" }, "clientId": { "type": "string" }, "description": { "type": "string" }, "internalCauseId": { "type": "string" }, "source": { "type": "string" }, "taskId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start timer", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/time/tracker/stop-timer": { "post": { "description": "Stop the key owner's running timer.\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-time-tracker-stop-timer", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string", "minutes": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "minutes": { "description": "Minutes.", "type": "integer" } }, "required": [ "id", "minutes" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"time:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"time:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "time:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Stop timer", "tags": [ "Time and billing" ], "x-modifies-data": true, "x-required-scope": "time:write" } }, "/api/actions/tracking/rut-monitor/add-watched-rut": { "post": { "description": "Add watched rut\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tracking-rut-monitor-add-watched-rut", "requestBody": { "content": { "application/json": { "example": { "args": [ { "corteId": 0, "label": "", "rut": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "corteId": { "type": "number" }, "label": { "type": "string" }, "rut": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add watched rut", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "product:write" } }, "/api/actions/tracking/rut-monitor/follow-rut-match": { "post": { "description": "Follow rut match\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tracking-rut-monitor-follow-rut-match", "requestBody": { "content": { "application/json": { "example": { "args": [ { "all": false, "id": "", "ids": [], "watchId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "all": { "type": "boolean" }, "id": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "watchId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causaId": "string", "followed": 0, "failed": 0, "failedIds": [ "string" ], "lastError": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "failed": { "type": "integer" }, "failedIds": { "items": { "type": "string" }, "type": "array" }, "followed": { "type": "integer" }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": "string" } }, "required": [ "causaId", "followed", "failed", "failedIds", "lastError" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Follow rut match", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "product:write" } }, "/api/actions/tracking/rut-monitor/list-watched-ruts": { "post": { "description": "List watched ruts\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tracking-rut-monitor-list-watched-ruts", "requestBody": { "content": { "application/json": { "example": { "args": [ { "competence": "", "estado": "", "limit": 0, "offset": 0, "onlyUnfollowed": false, "watchId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "competence": { "type": "string" }, "estado": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" }, "onlyUnfollowed": { "type": "boolean" }, "watchId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ruts": [ { "id": "string", "rut": "string", "label": "string", "name": "string", "corteId": 0, "active": true, "lastMatchAt": "2026-01-31T12:00:00Z", "createdAt": "2026-01-31T12:00:00Z", "matches": 0, "followed": 0, "scanState": "string", "lastScannedAt": "2026-01-31T12:00:00Z" } ], "matches": [ { "id": "string", "watchId": "string", "rut": "string", "competence": "string", "rol": "string", "court": "string", "caratulado": "string", "fechaIng": "2026-01-31T12:00:00Z", "participant": "string", "estado": "string", "causaId": "string", "createdAt": "2026-01-31T12:00:00Z" } ], "matchTotal": 0, "competenceCounts": { "\u003ckey\u003e": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "competenceCounts": { "additionalProperties": { "type": "integer" }, "description": "Matches per competence, for the selected watch (or all).", "type": "object" }, "matchTotal": { "type": "integer" }, "matches": { "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "court": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaIng": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "participant": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "watchId": { "type": "string" } }, "required": [ "id", "watchId", "rut", "competence", "rol", "court", "caratulado", "fechaIng", "participant", "estado", "causaId", "createdAt" ], "type": "object" }, "type": "array" }, "ruts": { "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "followed": { "type": "integer" }, "id": { "description": "Unique identifier.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "lastMatchAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastScannedAt": { "format": "date-time", "type": [ "string", "null" ] }, "matches": { "type": "integer" }, "name": { "description": "Display name.", "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "scanState": { "type": "string" } }, "required": [ "id", "rut", "label", "name", "corteId", "active", "lastMatchAt", "createdAt", "matches", "followed", "scanState", "lastScannedAt" ], "type": "object" }, "type": "array" } }, "required": [ "ruts", "matches", "matchTotal", "competenceCounts" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List watched ruts", "tags": [ "Integrations" ], "x-required-scope": "product:read" } }, "/api/actions/tracking/rut-monitor/remove-watched-rut": { "post": { "description": "Remove watched rut\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tracking-rut-monitor-remove-watched-rut", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove watched rut", "tags": [ "Integrations" ], "x-modifies-data": true, "x-required-scope": "product:write" } }, "/api/actions/tta/tracking/get-tta-cause": { "post": { "description": "Get tta causa\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tta-tracking-get-tta-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causa": { "id": "string", "rit": "string", "ruc": "string", "caratula": "string", "tribunal": "string", "procedimiento": "string", "etapa": "string", "estado": "string", "montoCuantia": "string" }, "actuaciones": [ { "id": "string", "fecha": "2026-01-31T12:00:00Z", "descripcion": "string", "createdAt": "2026-01-31T12:00:00Z" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "actuaciones": { "items": { "properties": { "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "descripcion": { "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id", "fecha", "descripcion", "createdAt" ], "type": "object" }, "type": "array" }, "causa": { "properties": { "caratula": { "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "etapa": { "description": "Procedural stage.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "montoCuantia": { "type": "string" }, "procedimiento": { "type": "string" }, "rit": { "description": "Causa RIT, for courts that number by RIT.", "type": "string" }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "id", "rit", "ruc", "caratula", "tribunal", "procedimiento", "etapa", "estado", "montoCuantia" ], "type": "object" } }, "required": [ "causa", "actuaciones" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tta causa", "tags": [ "Tax and Customs Courts (TTA)" ], "x-required-scope": "integrations:read" } }, "/api/actions/tta/tracking/get-tta-status": { "post": { "description": "Get tta status\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tta-tracking-get-tta-status", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "status": "string", "lastOkAt": "2026-01-31T12:00:00Z", "lastAttemptAt": "2026-01-31T12:00:00Z", "lastError": "string", "failingSince": "2026-01-31T12:00:00Z", "hasCausas": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "failingSince": { "description": "Failing since (ISO 8601); null when healthy.", "format": "date-time", "type": [ "string", "null" ] }, "hasCausas": { "description": "Whether any causas are linked.", "type": "boolean" }, "lastAttemptAt": { "description": "Last attempt (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": "string" }, "lastOkAt": { "description": "Last successful check (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "status", "lastOkAt", "lastAttemptAt", "lastError", "failingSince", "hasCausas" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get tta status", "tags": [ "Tax and Customs Courts (TTA)" ], "x-required-scope": "integrations:read" } }, "/api/actions/tta/tracking/import-tta-excel": { "post": { "description": "Import tta excel\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tta-tracking-import-tta-excel", "requestBody": { "content": { "application/json": { "example": { "args": [ { "contentBase64": "", "filename": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "contentBase64": { "type": "string" }, "filename": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "imported": 0, "state": { "status": "string", "lastOkAt": "2026-01-31T12:00:00Z", "lastAttemptAt": "2026-01-31T12:00:00Z", "lastError": "string", "failingSince": "2026-01-31T12:00:00Z", "hasCausas": true } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "imported": { "type": "integer" }, "state": { "description": "Current state.", "properties": { "failingSince": { "description": "Failing since (ISO 8601); null when healthy.", "format": "date-time", "type": [ "string", "null" ] }, "hasCausas": { "description": "Whether any causas are linked.", "type": "boolean" }, "lastAttemptAt": { "description": "Last attempt (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": "string" }, "lastOkAt": { "description": "Last successful check (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "status", "lastOkAt", "lastAttemptAt", "lastError", "failingSince", "hasCausas" ], "type": "object" } }, "required": [ "imported", "state" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Import tta excel", "tags": [ "Tax and Customs Courts (TTA)" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tta/tracking/list-tta-causes": { "post": { "description": "List tta causas\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tta-tracking-list-tta-causes", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "id": "string", "source": "string", "rit": "string", "ruc": "string", "caratula": "string", "tribunal": "string", "procedimiento": "string", "etapa": "string", "estado": "string", "montoCuantia": "string", "fechaPresentacion": "2026-01-31T12:00:00Z", "lastSyncAt": "2026-01-31T12:00:00Z", "actuaciones": 0, "lastActuacionAt": "2026-01-31T12:00:00Z" } ], "state": { "status": "string", "lastOkAt": "2026-01-31T12:00:00Z", "lastAttemptAt": "2026-01-31T12:00:00Z", "lastError": "string", "failingSince": "2026-01-31T12:00:00Z", "hasCausas": true } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "causas": { "description": "PJUD causas.", "items": { "properties": { "actuaciones": { "type": "integer" }, "caratula": { "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "etapa": { "description": "Procedural stage.", "type": "string" }, "fechaPresentacion": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "lastActuacionAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastSyncAt": { "format": "date-time", "type": [ "string", "null" ] }, "montoCuantia": { "type": "string" }, "procedimiento": { "type": "string" }, "rit": { "description": "Causa RIT, for courts that number by RIT.", "type": "string" }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": "string" }, "source": { "description": "Where the record came from.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "id", "source", "rit", "ruc", "caratula", "tribunal", "procedimiento", "etapa", "estado", "montoCuantia", "fechaPresentacion", "lastSyncAt", "actuaciones", "lastActuacionAt" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state.", "properties": { "failingSince": { "description": "Failing since (ISO 8601); null when healthy.", "format": "date-time", "type": [ "string", "null" ] }, "hasCausas": { "description": "Whether any causas are linked.", "type": "boolean" }, "lastAttemptAt": { "description": "Last attempt (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": "string" }, "lastOkAt": { "description": "Last successful check (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "status", "lastOkAt", "lastAttemptAt", "lastError", "failingSince", "hasCausas" ], "type": "object" } }, "required": [ "causas", "state" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List tta causas", "tags": [ "Tax and Customs Courts (TTA)" ], "x-required-scope": "integrations:read" } }, "/api/actions/tta/tracking/remove-tta-cause": { "post": { "description": "Remove tta causa\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tta-tracking-remove-tta-cause", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove tta causa", "tags": [ "Tax and Customs Courts (TTA)" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/tta/tracking/sync-tta": { "post": { "description": "Sync tta\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-tta-tracking-sync-tta", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "state": { "status": "string", "lastOkAt": "2026-01-31T12:00:00Z", "lastAttemptAt": "2026-01-31T12:00:00Z", "lastError": "string", "failingSince": "2026-01-31T12:00:00Z", "hasCausas": true } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "state": { "description": "Current state.", "properties": { "failingSince": { "description": "Failing since (ISO 8601); null when healthy.", "format": "date-time", "type": [ "string", "null" ] }, "hasCausas": { "description": "Whether any causas are linked.", "type": "boolean" }, "lastAttemptAt": { "description": "Last attempt (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": "string" }, "lastOkAt": { "description": "Last successful check (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "status": { "description": "Current status.", "type": "string" } }, "required": [ "status", "lastOkAt", "lastAttemptAt", "lastError", "failingSince", "hasCausas" ], "type": "object" } }, "required": [ "state" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"integrations:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"integrations:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "integrations:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Sync tta", "tags": [ "Tax and Customs Courts (TTA)" ], "x-modifies-data": true, "x-required-scope": "integrations:write" } }, "/api/actions/user/get-current-user-role": { "post": { "description": "Get current user role\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-user-get-current-user-role", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": "string", "schema": { "description": "Name of the account role of the user acting for the key (its owner); empty when the account has none.", "type": "string" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get current user role", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/watch/queries/get-watch-summary": { "post": { "description": "Get watch summary\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-watch-queries-get-watch-summary", "requestBody": { "content": { "application/json": { "example": { "args": [ { "upcomingMax": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "upcomingMax": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "briefing": "string", "date": "string", "generatedAt": "2026-01-31T12:00:00Z", "today": [ { "id": "string", "kind": "string", "label": "string", "rol": "string", "caratulado": "string", "location": "string", "at": "2026-01-31T12:00:00Z", "allDay": true, "taskId": "string", "causaId": "string", "displayTitle": "string", "whenLabel": "string" } ], "upcoming": [ { "id": "string", "kind": "string", "label": "string", "rol": "string", "caratulado": "string", "location": "string", "at": "2026-01-31T12:00:00Z", "allDay": true, "taskId": "string", "causaId": "string", "displayTitle": "string", "whenLabel": "string" } ], "overdueTasks": 0 } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "briefing": { "type": "string" }, "date": { "description": "Date (ISO 8601).", "type": "string" }, "generatedAt": { "format": "date-time", "type": "string" }, "overdueTasks": { "type": "integer" }, "today": { "items": { "properties": { "allDay": { "type": "boolean" }, "at": { "format": "date-time", "type": "string" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "displayTitle": { "description": "DisplayTitle and WhenLabel are the words to show, in the user's language (watch_summary_text.go), the same on every watch and car.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "location": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "whenLabel": { "type": "string" } }, "required": [ "id", "kind", "label", "rol", "caratulado", "location", "at", "allDay", "displayTitle", "whenLabel" ], "type": "object" }, "type": "array" }, "upcoming": { "items": { "properties": { "allDay": { "type": "boolean" }, "at": { "format": "date-time", "type": "string" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "displayTitle": { "description": "DisplayTitle and WhenLabel are the words to show, in the user's language (watch_summary_text.go), the same on every watch and car.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "label": { "description": "Human-readable label.", "type": "string" }, "location": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "taskId": { "description": "Task id.", "type": "string" }, "whenLabel": { "type": "string" } }, "required": [ "id", "kind", "label", "rol", "caratulado", "location", "at", "allDay", "displayTitle", "whenLabel" ], "type": "object" }, "type": "array" } }, "required": [ "briefing", "date", "generatedAt", "today", "upcoming", "overdueTasks" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"product:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"product:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "product:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get watch summary", "tags": [ "Other product features" ], "x-required-scope": "product:read" } }, "/api/actions/workflows/workflows/attach-workflow": { "post": { "description": "Attach workflow\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-attach-workflow", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "internalCauseId": "", "procedureKey": "", "replace": false, "workflowId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "internalCauseId": { "type": "string" }, "procedureKey": { "type": "string" }, "replace": { "type": "boolean" }, "workflowId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Attach workflow", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/copy-workflow": { "post": { "description": "Copy workflow\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-copy-workflow", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Copy workflow", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/delete-workflow": { "post": { "description": "Delete workflow\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-delete-workflow", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete workflow", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/delete-workflow-action": { "post": { "description": "Delete workflow action\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-delete-workflow-action", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete workflow action", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/delete-workflow-stage": { "post": { "description": "Delete workflow stage\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-delete-workflow-stage", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete workflow stage", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/get-case-workflow": { "post": { "description": "Get case workflow\n\nAuthentication: developer API key. Required scope: `workflows:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-get-case-workflow", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaId": "", "internalCauseId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaId": { "type": "string" }, "internalCauseId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "runs": [ { "id": "string", "workflow": "string", "status": "string", "pendingConfirmation": true, "stage": "string", "transition": "string", "transitionDays": 0, "stageStartedAt": "2026-01-31T12:00:00Z", "stageCount": 0, "stageIndex": 0, "events": [ { "kind": "string", "message": "string", "reason": "string", "at": "2026-01-31T12:00:00Z", "by": "string" } ] } ], "workflows": [ { "id": "string", "name": "string" } ] } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "runs": { "items": { "properties": { "events": { "description": "Latest 30 events of the run, newest first.", "items": { "properties": { "at": { "format": "date-time", "type": "string" }, "by": { "description": "Actor name; empty for automatic events.", "type": "string" }, "kind": { "description": "Event kind.", "type": "string" }, "message": { "type": "string" }, "reason": { "description": "Type of the record the event refers to; may be empty.", "type": "string" } }, "required": [ "kind", "message", "reason", "at", "by" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "pendingConfirmation": { "type": "boolean" }, "stage": { "type": "string" }, "stageCount": { "type": "integer" }, "stageIndex": { "type": "integer" }, "stageStartedAt": { "format": "date-time", "type": "string" }, "status": { "description": "Current status.", "type": "string" }, "transition": { "type": "string" }, "transitionDays": { "type": "integer" }, "workflow": { "type": "string" } }, "required": [ "id", "workflow", "status", "pendingConfirmation", "stage", "transition", "transitionDays", "stageStartedAt", "stageCount", "stageIndex", "events" ], "type": "object" }, "type": "array" }, "workflows": { "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "type": "array" } }, "required": [ "runs", "workflows" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get case workflow", "tags": [ "Workflows" ], "x-required-scope": "workflows:read" } }, "/api/actions/workflows/workflows/get-workflow": { "post": { "description": "Get workflow\n\nAuthentication: developer API key. Required scope: `workflows:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-get-workflow", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "workflow": { "id": "string", "name": "string", "description": "string", "tags": [ "string" ], "active": true, "stages": [ { "id": "string", "name": "string", "transition": "string", "transitionDays": 0, "actions": [ { "id": "string", "kind": "ASSIGN_TASK", "config": { "title": "string", "description": "string", "assigneeIds": [ "string" ], "reviewerId": "string", "durationDays": 0, "offsetDays": 0, "hour": 0, "inviteClient": true, "dueDays": 0 } } ] } ] }, "canEdit": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "workflow": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "description": { "description": "Free-text description.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "stages": { "description": "Stages.", "items": { "properties": { "actions": { "description": "Actions run when the stage starts, in order.", "items": { "properties": { "config": { "description": "Action settings; zero-valued optional keys are omitted.", "properties": { "assigneeIds": { "items": { "type": "string" }, "type": "array" }, "description": { "description": "Free-text description.", "type": "string" }, "dueDays": { "type": "integer" }, "durationDays": { "type": "integer" }, "hour": { "description": "Hour of day of a scheduled meeting.", "type": "integer" }, "inviteClient": { "type": "boolean" }, "offsetDays": { "description": "Days after the stage starts.", "type": "integer" }, "reviewerId": { "type": "string" }, "title": { "description": "Title.", "type": "string" } }, "required": [ "title", "description" ], "type": "object" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "enum": [ "ASSIGN_TASK", "SCHEDULE_MEETING", "REQUEST_DOCUMENT" ], "type": "string" } }, "required": [ "id", "kind", "config" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "transition": { "type": "string" }, "transitionDays": { "type": "integer" } }, "required": [ "id", "name", "transition", "transitionDays", "actions" ], "type": "object" }, "type": "array" }, "tags": { "description": "Tags.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "name", "description", "tags", "active", "stages" ], "type": "object" } }, "required": [ "workflow", "canEdit" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get workflow", "tags": [ "Workflows" ], "x-required-scope": "workflows:read" } }, "/api/actions/workflows/workflows/list-workflows": { "post": { "description": "List workflows\n\nAuthentication: developer API key. Required scope: `workflows:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-list-workflows", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "workflows": [ { "id": "string", "name": "string", "description": "string", "tags": [ "string" ], "active": true, "stages": 0, "activeRuns": 0 } ], "canEdit": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "workflows": { "items": { "properties": { "active": { "description": "Whether the record is active.", "type": "boolean" }, "activeRuns": { "type": "integer" }, "description": { "description": "Free-text description.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "stages": { "description": "Stages.", "type": "integer" }, "tags": { "description": "Tags.", "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "name", "description", "tags", "active", "stages", "activeRuns" ], "type": "object" }, "type": "array" } }, "required": [ "workflows", "canEdit" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List workflows", "tags": [ "Workflows" ], "x-required-scope": "workflows:read" } }, "/api/actions/workflows/workflows/move-workflow-stage": { "post": { "description": "Move workflow stage\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-move-workflow-stage", "requestBody": { "content": { "application/json": { "example": { "args": [ { "dir": 0, "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "dir": { "type": "number" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Move workflow stage", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/save-workflow": { "post": { "description": "Save workflow\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-save-workflow", "requestBody": { "content": { "application/json": { "example": { "args": [ { "description": "", "id": "", "name": "", "tags": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save workflow", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/save-workflow-action": { "post": { "description": "Save workflow action\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-save-workflow-action", "requestBody": { "content": { "application/json": { "example": { "args": [ { "config": { "assigneeIds": [], "description": "", "dueDays": 0, "durationDays": 0, "hour": 0, "inviteClient": false, "offsetDays": 0, "reviewerId": "", "title": "" }, "id": "", "kind": "", "stageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "config": { "type": "object" }, "id": { "type": "string" }, "kind": { "type": "string" }, "stageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save workflow action", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/save-workflow-stage": { "post": { "description": "Save workflow stage\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-save-workflow-stage", "requestBody": { "content": { "application/json": { "example": { "args": [ { "id": "", "name": "", "transition": "", "transitionDays": 0, "workflowId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "transition": { "type": "string" }, "transitionDays": { "type": "number" }, "workflowId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "id": { "description": "Unique identifier.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Save workflow stage", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/set-workflow-active": { "post": { "description": "Set workflow active\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-set-workflow-active", "requestBody": { "content": { "application/json": { "example": { "args": [ { "active": false, "id": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set workflow active", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/workflows/workflows/workflow-run-command": { "post": { "description": "Workflow run command\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-workflows-workflows-workflow-run-command", "requestBody": { "content": { "application/json": { "example": { "args": [ { "op": "", "runId": "", "stageId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "op": { "type": "string" }, "runId": { "type": "string" }, "stageId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "ok": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "required": [ "ok" ], "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"workflows:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"workflows:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "workflows:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Workflow run command", "tags": [ "Workflows" ], "x-modifies-data": true, "x-required-scope": "workflows:write" } }, "/api/actions/writings/mutations/answer-batch-gaps": { "post": { "description": "Answer batch gaps\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-mutations-answer-batch-gaps", "requestBody": { "content": { "application/json": { "example": { "args": [ { "batchId": "", "perItem": {}, "shared": {} } ] }, "schema": { "properties": { "args": { "items": { "properties": { "batchId": { "type": "string" }, "perItem": { "type": "object" }, "shared": { "type": "object" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "batch": { "id": "string", "source": "plantilla", "plantillaId": "string", "tipo": "string", "titulo": "string", "state": "DRAFTING", "sharedValues": { "\u003ckey\u003e": "string" }, "createdById": "string", "createdAt": "2026-01-31T12:00:00Z", "confirmedById": "string", "confirmedAt": "2026-01-31T12:00:00Z", "requiereIA": true, "canal": "string" }, "items": [ { "id": "string", "causaRef": "string", "causaKind": "bc", "rol": "string", "tribunal": "string", "caratula": "string", "escritoKind": "generic", "escritoRef": "string", "state": "PENDING", "error": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "shared": true } ], "answers": { "\u003ckey\u003e": "string" }, "channels": [ { "canal": "bc", "jobId": "string", "state": "string", "status": "pending", "error": "string", "folio": "string", "numeroIngreso": "string", "enabled": true } ], "filable": true, "hasPreview": true } ], "counts": { "\u003ckey\u003e": 0 }, "sharedGaps": [ { "clave": "string", "pregunta": "string", "items": 0 } ], "filableCount": 0, "pjudFilingEnabled": true, "editable": true, "generating": true, "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "batch": { "properties": { "canal": { "description": "Plantilla filing channel (bc, pjud, auto); empty for tipo batches.", "type": "string" }, "confirmedAt": { "format": "date-time", "type": [ "string", "null" ] }, "confirmedById": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdById": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "plantillaId": { "type": [ "string", "null" ] }, "requiereIA": { "description": "Whether the batch's plantilla is drafted with AI.", "type": "boolean" }, "sharedValues": { "additionalProperties": { "type": "string" }, "description": "Answers to gaps shared by every item, keyed by gap key.", "type": "object" }, "source": { "description": "Where the record came from.", "enum": [ "plantilla", "tipo" ], "type": "string" }, "state": { "description": "Current state.", "enum": [ "DRAFTING", "REVIEW", "CONFIRMED", "DONE", "CANCELLED" ], "type": "string" }, "tipo": { "description": "Catalogue escrito tipo when source is tipo.", "type": [ "string", "null" ] }, "titulo": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "plantillaId", "tipo", "titulo", "state", "sharedValues", "createdById", "createdAt", "confirmedById", "confirmedAt", "requiereIA", "canal" ], "type": "object" }, "canManage": { "type": "boolean" }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Items per state.", "type": "object" }, "editable": { "type": "boolean" }, "filableCount": { "type": "integer" }, "generating": { "description": "Whether items are still pending or generating.", "type": "boolean" }, "items": { "description": "The records returned.", "items": { "properties": { "answers": { "additionalProperties": { "type": "string" }, "description": "Per-item gap answers, keyed by gap key.", "type": "object" }, "caratula": { "type": "string" }, "causaKind": { "enum": [ "bc", "pjud" ], "type": "string" }, "causaRef": { "description": "Id of the BC or PJUD causa.", "type": "string" }, "channels": { "description": "Filing channels of the item; empty until the batch is confirmed.", "items": { "properties": { "canal": { "enum": [ "bc", "pjud" ], "type": "string" }, "enabled": { "description": "False for a PJUD channel while PJUD filing is disabled for the organization.", "type": "boolean" }, "error": { "type": [ "string", "null" ] }, "folio": { "description": "Folio of a filed escrito, once known.", "type": [ "string", "null" ] }, "jobId": { "description": "Filing job id; empty when no job could be queued.", "type": "string" }, "numeroIngreso": { "description": "PJUD ingreso number of a filed escrito, once known.", "type": [ "string", "null" ] }, "state": { "description": "Filing job state (PENDING, CLAIMED, RUNNING, SUCCEEDED, FAILED, BLOCKED_DISABLED, CANCELLED).", "type": "string" }, "status": { "description": "Display status of the channel.", "enum": [ "pending", "sent", "error", "disabled", "" ], "type": "string" } }, "required": [ "canal", "enabled" ], "type": "object" }, "type": "array" }, "error": { "description": "Empty when there is no error.", "type": "string" }, "escritoKind": { "enum": [ "generic", "liquidador" ], "type": "string" }, "escritoRef": { "description": "Id of the generated escrito; empty until generated.", "type": "string" }, "filable": { "description": "Whether confirming the batch would file this item.", "type": "boolean" }, "hasPreview": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "missingFields": { "items": { "properties": { "clave": { "description": "Gap key.", "type": "string" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "shared": { "description": "Whether the gap is answered once for the whole batch.", "type": "boolean" } }, "required": [ "clave", "pregunta", "shared" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "state": { "description": "Current state.", "enum": [ "PENDING", "GENERATING", "READY", "NEEDS_DATA", "ERROR", "EXCLUDED", "QUEUED", "FILED", "FAILED" ], "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "id", "causaRef", "causaKind", "rol", "tribunal", "caratula", "escritoKind", "escritoRef", "state", "error", "missingFields", "answers", "channels", "filable", "hasPreview" ], "type": "object" }, "type": "array" }, "pjudFilingEnabled": { "type": "boolean" }, "sharedGaps": { "description": "Shared gaps of the items in NEEDS_DATA, most common first.", "items": { "properties": { "clave": { "type": "string" }, "items": { "description": "Items waiting on this gap.", "type": "integer" }, "pregunta": { "type": "string" } }, "required": [ "clave", "pregunta", "items" ], "type": "object" }, "type": "array" } }, "required": [ "batch", "items", "counts", "sharedGaps", "filableCount", "pjudFilingEnabled", "editable", "generating", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Answer batch gaps", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/actions/writings/mutations/confirm-escrito-batch": { "post": { "description": "Confirm escrito batch\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-mutations-confirm-escrito-batch", "requestBody": { "content": { "application/json": { "example": { "args": [ { "batchId": "", "confirmed": false, "confirmedCount": 0 } ] }, "schema": { "properties": { "args": { "items": { "properties": { "batchId": { "type": "string" }, "confirmed": { "type": "boolean" }, "confirmedCount": { "type": "number" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "batch": { "id": "string", "source": "plantilla", "plantillaId": "string", "tipo": "string", "titulo": "string", "state": "DRAFTING", "sharedValues": { "\u003ckey\u003e": "string" }, "createdById": "string", "createdAt": "2026-01-31T12:00:00Z", "confirmedById": "string", "confirmedAt": "2026-01-31T12:00:00Z", "requiereIA": true, "canal": "string" }, "items": [ { "id": "string", "causaRef": "string", "causaKind": "bc", "rol": "string", "tribunal": "string", "caratula": "string", "escritoKind": "generic", "escritoRef": "string", "state": "PENDING", "error": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "shared": true } ], "answers": { "\u003ckey\u003e": "string" }, "channels": [ { "canal": "bc", "jobId": "string", "state": "string", "status": "pending", "error": "string", "folio": "string", "numeroIngreso": "string", "enabled": true } ], "filable": true, "hasPreview": true } ], "counts": { "\u003ckey\u003e": 0 }, "sharedGaps": [ { "clave": "string", "pregunta": "string", "items": 0 } ], "filableCount": 0, "pjudFilingEnabled": true, "editable": true, "generating": true, "canManage": true, "confirmation": { "queued": 0, "failed": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "batch": { "properties": { "canal": { "description": "Plantilla filing channel (bc, pjud, auto); empty for tipo batches.", "type": "string" }, "confirmedAt": { "format": "date-time", "type": [ "string", "null" ] }, "confirmedById": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdById": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "plantillaId": { "type": [ "string", "null" ] }, "requiereIA": { "description": "Whether the batch's plantilla is drafted with AI.", "type": "boolean" }, "sharedValues": { "additionalProperties": { "type": "string" }, "description": "Answers to gaps shared by every item, keyed by gap key.", "type": "object" }, "source": { "description": "Where the record came from.", "enum": [ "plantilla", "tipo" ], "type": "string" }, "state": { "description": "Current state.", "enum": [ "DRAFTING", "REVIEW", "CONFIRMED", "DONE", "CANCELLED" ], "type": "string" }, "tipo": { "description": "Catalogue escrito tipo when source is tipo.", "type": [ "string", "null" ] }, "titulo": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "plantillaId", "tipo", "titulo", "state", "sharedValues", "createdById", "createdAt", "confirmedById", "confirmedAt", "requiereIA", "canal" ], "type": "object" }, "canManage": { "type": "boolean" }, "confirmation": { "properties": { "failed": { "description": "Items that could not be queued.", "type": "integer" }, "queued": { "description": "Items whose filing was queued.", "type": "integer" } }, "required": [ "queued", "failed" ], "type": "object" }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Items per state.", "type": "object" }, "editable": { "type": "boolean" }, "filableCount": { "type": "integer" }, "generating": { "description": "Whether items are still pending or generating.", "type": "boolean" }, "items": { "description": "The records returned.", "items": { "properties": { "answers": { "additionalProperties": { "type": "string" }, "description": "Per-item gap answers, keyed by gap key.", "type": "object" }, "caratula": { "type": "string" }, "causaKind": { "enum": [ "bc", "pjud" ], "type": "string" }, "causaRef": { "description": "Id of the BC or PJUD causa.", "type": "string" }, "channels": { "description": "Filing channels of the item; empty until the batch is confirmed.", "items": { "properties": { "canal": { "enum": [ "bc", "pjud" ], "type": "string" }, "enabled": { "description": "False for a PJUD channel while PJUD filing is disabled for the organization.", "type": "boolean" }, "error": { "type": [ "string", "null" ] }, "folio": { "description": "Folio of a filed escrito, once known.", "type": [ "string", "null" ] }, "jobId": { "description": "Filing job id; empty when no job could be queued.", "type": "string" }, "numeroIngreso": { "description": "PJUD ingreso number of a filed escrito, once known.", "type": [ "string", "null" ] }, "state": { "description": "Filing job state (PENDING, CLAIMED, RUNNING, SUCCEEDED, FAILED, BLOCKED_DISABLED, CANCELLED).", "type": "string" }, "status": { "description": "Display status of the channel.", "enum": [ "pending", "sent", "error", "disabled", "" ], "type": "string" } }, "required": [ "canal", "enabled" ], "type": "object" }, "type": "array" }, "error": { "description": "Empty when there is no error.", "type": "string" }, "escritoKind": { "enum": [ "generic", "liquidador" ], "type": "string" }, "escritoRef": { "description": "Id of the generated escrito; empty until generated.", "type": "string" }, "filable": { "description": "Whether confirming the batch would file this item.", "type": "boolean" }, "hasPreview": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "missingFields": { "items": { "properties": { "clave": { "description": "Gap key.", "type": "string" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "shared": { "description": "Whether the gap is answered once for the whole batch.", "type": "boolean" } }, "required": [ "clave", "pregunta", "shared" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "state": { "description": "Current state.", "enum": [ "PENDING", "GENERATING", "READY", "NEEDS_DATA", "ERROR", "EXCLUDED", "QUEUED", "FILED", "FAILED" ], "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "id", "causaRef", "causaKind", "rol", "tribunal", "caratula", "escritoKind", "escritoRef", "state", "error", "missingFields", "answers", "channels", "filable", "hasPreview" ], "type": "object" }, "type": "array" }, "pjudFilingEnabled": { "type": "boolean" }, "sharedGaps": { "description": "Shared gaps of the items in NEEDS_DATA, most common first.", "items": { "properties": { "clave": { "type": "string" }, "items": { "description": "Items waiting on this gap.", "type": "integer" }, "pregunta": { "type": "string" } }, "required": [ "clave", "pregunta", "items" ], "type": "object" }, "type": "array" } }, "required": [ "batch", "items", "counts", "sharedGaps", "filableCount", "pjudFilingEnabled", "editable", "generating", "canManage", "confirmation" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Confirm escrito batch", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/writings/mutations/confirm-escrito-filings": { "post": { "description": "Confirm escrito filings\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-mutations-confirm-escrito-filings", "requestBody": { "content": { "application/json": { "example": { "args": [ { "confirmed": false, "items": [] } ] }, "schema": { "properties": { "args": { "items": { "properties": { "confirmed": { "type": "boolean" }, "items": { "items": { "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "results": [ { "escritoKind": "string", "escritoRef": "string", "canales": [ { "canal": "string", "jobId": "string", "state": "string", "error": "string" } ], "error": "string" } ], "pjudFilingEnabled": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "pjudFilingEnabled": { "type": "boolean" }, "results": { "description": "The results.", "items": { "properties": { "canales": { "items": { "properties": { "canal": { "type": "string" }, "error": { "type": "string" }, "jobId": { "description": "Background job id.", "type": "string" }, "state": { "description": "Current state.", "type": "string" } }, "required": [ "canal" ], "type": "object" }, "type": "array" }, "error": { "type": "string" }, "escritoKind": { "type": "string" }, "escritoRef": { "type": "string" } }, "required": [ "escritoKind", "escritoRef", "canales" ], "type": "object" }, "type": "array" } }, "required": [ "results", "pjudFilingEnabled" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Confirm escrito filings", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/writings/mutations/create-escrito-batch": { "post": { "description": "Create escrito batch\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-mutations-create-escrito-batch", "requestBody": { "content": { "application/json": { "example": { "args": [ { "causaRefs": [], "plantillaId": "", "source": "", "tipo": "", "titulo": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "causaRefs": { "items": { "type": "string" }, "type": "array" }, "plantillaId": { "type": "string" }, "source": { "type": "string" }, "tipo": { "type": "string" }, "titulo": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "batch": { "id": "string", "source": "plantilla", "plantillaId": "string", "tipo": "string", "titulo": "string", "state": "DRAFTING", "sharedValues": { "\u003ckey\u003e": "string" }, "createdById": "string", "createdAt": "2026-01-31T12:00:00Z", "confirmedById": "string", "confirmedAt": "2026-01-31T12:00:00Z", "requiereIA": true, "canal": "string" }, "items": [ { "id": "string", "causaRef": "string", "causaKind": "bc", "rol": "string", "tribunal": "string", "caratula": "string", "escritoKind": "generic", "escritoRef": "string", "state": "PENDING", "error": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "shared": true } ], "answers": { "\u003ckey\u003e": "string" }, "channels": [ { "canal": "bc", "jobId": "string", "state": "string", "status": "pending", "error": "string", "folio": "string", "numeroIngreso": "string", "enabled": true } ], "filable": true, "hasPreview": true } ], "counts": { "\u003ckey\u003e": 0 }, "sharedGaps": [ { "clave": "string", "pregunta": "string", "items": 0 } ], "filableCount": 0, "pjudFilingEnabled": true, "editable": true, "generating": true, "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "batch": { "properties": { "canal": { "description": "Plantilla filing channel (bc, pjud, auto); empty for tipo batches.", "type": "string" }, "confirmedAt": { "format": "date-time", "type": [ "string", "null" ] }, "confirmedById": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdById": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "plantillaId": { "type": [ "string", "null" ] }, "requiereIA": { "description": "Whether the batch's plantilla is drafted with AI.", "type": "boolean" }, "sharedValues": { "additionalProperties": { "type": "string" }, "description": "Answers to gaps shared by every item, keyed by gap key.", "type": "object" }, "source": { "description": "Where the record came from.", "enum": [ "plantilla", "tipo" ], "type": "string" }, "state": { "description": "Current state.", "enum": [ "DRAFTING", "REVIEW", "CONFIRMED", "DONE", "CANCELLED" ], "type": "string" }, "tipo": { "description": "Catalogue escrito tipo when source is tipo.", "type": [ "string", "null" ] }, "titulo": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "plantillaId", "tipo", "titulo", "state", "sharedValues", "createdById", "createdAt", "confirmedById", "confirmedAt", "requiereIA", "canal" ], "type": "object" }, "canManage": { "type": "boolean" }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Items per state.", "type": "object" }, "editable": { "type": "boolean" }, "filableCount": { "type": "integer" }, "generating": { "description": "Whether items are still pending or generating.", "type": "boolean" }, "items": { "description": "The records returned.", "items": { "properties": { "answers": { "additionalProperties": { "type": "string" }, "description": "Per-item gap answers, keyed by gap key.", "type": "object" }, "caratula": { "type": "string" }, "causaKind": { "enum": [ "bc", "pjud" ], "type": "string" }, "causaRef": { "description": "Id of the BC or PJUD causa.", "type": "string" }, "channels": { "description": "Filing channels of the item; empty until the batch is confirmed.", "items": { "properties": { "canal": { "enum": [ "bc", "pjud" ], "type": "string" }, "enabled": { "description": "False for a PJUD channel while PJUD filing is disabled for the organization.", "type": "boolean" }, "error": { "type": [ "string", "null" ] }, "folio": { "description": "Folio of a filed escrito, once known.", "type": [ "string", "null" ] }, "jobId": { "description": "Filing job id; empty when no job could be queued.", "type": "string" }, "numeroIngreso": { "description": "PJUD ingreso number of a filed escrito, once known.", "type": [ "string", "null" ] }, "state": { "description": "Filing job state (PENDING, CLAIMED, RUNNING, SUCCEEDED, FAILED, BLOCKED_DISABLED, CANCELLED).", "type": "string" }, "status": { "description": "Display status of the channel.", "enum": [ "pending", "sent", "error", "disabled", "" ], "type": "string" } }, "required": [ "canal", "enabled" ], "type": "object" }, "type": "array" }, "error": { "description": "Empty when there is no error.", "type": "string" }, "escritoKind": { "enum": [ "generic", "liquidador" ], "type": "string" }, "escritoRef": { "description": "Id of the generated escrito; empty until generated.", "type": "string" }, "filable": { "description": "Whether confirming the batch would file this item.", "type": "boolean" }, "hasPreview": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "missingFields": { "items": { "properties": { "clave": { "description": "Gap key.", "type": "string" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "shared": { "description": "Whether the gap is answered once for the whole batch.", "type": "boolean" } }, "required": [ "clave", "pregunta", "shared" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "state": { "description": "Current state.", "enum": [ "PENDING", "GENERATING", "READY", "NEEDS_DATA", "ERROR", "EXCLUDED", "QUEUED", "FILED", "FAILED" ], "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "id", "causaRef", "causaKind", "rol", "tribunal", "caratula", "escritoKind", "escritoRef", "state", "error", "missingFields", "answers", "channels", "filable", "hasPreview" ], "type": "object" }, "type": "array" }, "pjudFilingEnabled": { "type": "boolean" }, "sharedGaps": { "description": "Shared gaps of the items in NEEDS_DATA, most common first.", "items": { "properties": { "clave": { "type": "string" }, "items": { "description": "Items waiting on this gap.", "type": "integer" }, "pregunta": { "type": "string" } }, "required": [ "clave", "pregunta", "items" ], "type": "object" }, "type": "array" } }, "required": [ "batch", "items", "counts", "sharedGaps", "filableCount", "pjudFilingEnabled", "editable", "generating", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create escrito batch", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/writings/mutations/set-batch-item-excluded": { "post": { "description": "Set batch item excluded\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-mutations-set-batch-item-excluded", "requestBody": { "content": { "application/json": { "example": { "args": [ { "batchId": "", "excluded": false, "itemId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "batchId": { "type": "string" }, "excluded": { "type": "boolean" }, "itemId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "batch": { "id": "string", "source": "plantilla", "plantillaId": "string", "tipo": "string", "titulo": "string", "state": "DRAFTING", "sharedValues": { "\u003ckey\u003e": "string" }, "createdById": "string", "createdAt": "2026-01-31T12:00:00Z", "confirmedById": "string", "confirmedAt": "2026-01-31T12:00:00Z", "requiereIA": true, "canal": "string" }, "items": [ { "id": "string", "causaRef": "string", "causaKind": "bc", "rol": "string", "tribunal": "string", "caratula": "string", "escritoKind": "generic", "escritoRef": "string", "state": "PENDING", "error": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "shared": true } ], "answers": { "\u003ckey\u003e": "string" }, "channels": [ { "canal": "bc", "jobId": "string", "state": "string", "status": "pending", "error": "string", "folio": "string", "numeroIngreso": "string", "enabled": true } ], "filable": true, "hasPreview": true } ], "counts": { "\u003ckey\u003e": 0 }, "sharedGaps": [ { "clave": "string", "pregunta": "string", "items": 0 } ], "filableCount": 0, "pjudFilingEnabled": true, "editable": true, "generating": true, "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "batch": { "properties": { "canal": { "description": "Plantilla filing channel (bc, pjud, auto); empty for tipo batches.", "type": "string" }, "confirmedAt": { "format": "date-time", "type": [ "string", "null" ] }, "confirmedById": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdById": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "plantillaId": { "type": [ "string", "null" ] }, "requiereIA": { "description": "Whether the batch's plantilla is drafted with AI.", "type": "boolean" }, "sharedValues": { "additionalProperties": { "type": "string" }, "description": "Answers to gaps shared by every item, keyed by gap key.", "type": "object" }, "source": { "description": "Where the record came from.", "enum": [ "plantilla", "tipo" ], "type": "string" }, "state": { "description": "Current state.", "enum": [ "DRAFTING", "REVIEW", "CONFIRMED", "DONE", "CANCELLED" ], "type": "string" }, "tipo": { "description": "Catalogue escrito tipo when source is tipo.", "type": [ "string", "null" ] }, "titulo": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "plantillaId", "tipo", "titulo", "state", "sharedValues", "createdById", "createdAt", "confirmedById", "confirmedAt", "requiereIA", "canal" ], "type": "object" }, "canManage": { "type": "boolean" }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Items per state.", "type": "object" }, "editable": { "type": "boolean" }, "filableCount": { "type": "integer" }, "generating": { "description": "Whether items are still pending or generating.", "type": "boolean" }, "items": { "description": "The records returned.", "items": { "properties": { "answers": { "additionalProperties": { "type": "string" }, "description": "Per-item gap answers, keyed by gap key.", "type": "object" }, "caratula": { "type": "string" }, "causaKind": { "enum": [ "bc", "pjud" ], "type": "string" }, "causaRef": { "description": "Id of the BC or PJUD causa.", "type": "string" }, "channels": { "description": "Filing channels of the item; empty until the batch is confirmed.", "items": { "properties": { "canal": { "enum": [ "bc", "pjud" ], "type": "string" }, "enabled": { "description": "False for a PJUD channel while PJUD filing is disabled for the organization.", "type": "boolean" }, "error": { "type": [ "string", "null" ] }, "folio": { "description": "Folio of a filed escrito, once known.", "type": [ "string", "null" ] }, "jobId": { "description": "Filing job id; empty when no job could be queued.", "type": "string" }, "numeroIngreso": { "description": "PJUD ingreso number of a filed escrito, once known.", "type": [ "string", "null" ] }, "state": { "description": "Filing job state (PENDING, CLAIMED, RUNNING, SUCCEEDED, FAILED, BLOCKED_DISABLED, CANCELLED).", "type": "string" }, "status": { "description": "Display status of the channel.", "enum": [ "pending", "sent", "error", "disabled", "" ], "type": "string" } }, "required": [ "canal", "enabled" ], "type": "object" }, "type": "array" }, "error": { "description": "Empty when there is no error.", "type": "string" }, "escritoKind": { "enum": [ "generic", "liquidador" ], "type": "string" }, "escritoRef": { "description": "Id of the generated escrito; empty until generated.", "type": "string" }, "filable": { "description": "Whether confirming the batch would file this item.", "type": "boolean" }, "hasPreview": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "missingFields": { "items": { "properties": { "clave": { "description": "Gap key.", "type": "string" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "shared": { "description": "Whether the gap is answered once for the whole batch.", "type": "boolean" } }, "required": [ "clave", "pregunta", "shared" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "state": { "description": "Current state.", "enum": [ "PENDING", "GENERATING", "READY", "NEEDS_DATA", "ERROR", "EXCLUDED", "QUEUED", "FILED", "FAILED" ], "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "id", "causaRef", "causaKind", "rol", "tribunal", "caratula", "escritoKind", "escritoRef", "state", "error", "missingFields", "answers", "channels", "filable", "hasPreview" ], "type": "object" }, "type": "array" }, "pjudFilingEnabled": { "type": "boolean" }, "sharedGaps": { "description": "Shared gaps of the items in NEEDS_DATA, most common first.", "items": { "properties": { "clave": { "type": "string" }, "items": { "description": "Items waiting on this gap.", "type": "integer" }, "pregunta": { "type": "string" } }, "required": [ "clave", "pregunta", "items" ], "type": "object" }, "type": "array" } }, "required": [ "batch", "items", "counts", "sharedGaps", "filableCount", "pjudFilingEnabled", "editable", "generating", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set batch item excluded", "tags": [ "Expedientes and activity" ], "x-modifies-data": true, "x-required-scope": "documents:write" } }, "/api/actions/writings/queries/get-escrito-batch": { "post": { "description": "Get escrito batch\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-queries-get-escrito-batch", "requestBody": { "content": { "application/json": { "example": { "args": [ { "batchId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "batchId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "batch": { "id": "string", "source": "plantilla", "plantillaId": "string", "tipo": "string", "titulo": "string", "state": "DRAFTING", "sharedValues": { "\u003ckey\u003e": "string" }, "createdById": "string", "createdAt": "2026-01-31T12:00:00Z", "confirmedById": "string", "confirmedAt": "2026-01-31T12:00:00Z", "requiereIA": true, "canal": "string" }, "items": [ { "id": "string", "causaRef": "string", "causaKind": "bc", "rol": "string", "tribunal": "string", "caratula": "string", "escritoKind": "generic", "escritoRef": "string", "state": "PENDING", "error": "string", "missingFields": [ { "clave": "string", "pregunta": "string", "shared": true } ], "answers": { "\u003ckey\u003e": "string" }, "channels": [ { "canal": "bc", "jobId": "string", "state": "string", "status": "pending", "error": "string", "folio": "string", "numeroIngreso": "string", "enabled": true } ], "filable": true, "hasPreview": true } ], "counts": { "\u003ckey\u003e": 0 }, "sharedGaps": [ { "clave": "string", "pregunta": "string", "items": 0 } ], "filableCount": 0, "pjudFilingEnabled": true, "editable": true, "generating": true, "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "batch": { "properties": { "canal": { "description": "Plantilla filing channel (bc, pjud, auto); empty for tipo batches.", "type": "string" }, "confirmedAt": { "format": "date-time", "type": [ "string", "null" ] }, "confirmedById": { "type": [ "string", "null" ] }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdById": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "plantillaId": { "type": [ "string", "null" ] }, "requiereIA": { "description": "Whether the batch's plantilla is drafted with AI.", "type": "boolean" }, "sharedValues": { "additionalProperties": { "type": "string" }, "description": "Answers to gaps shared by every item, keyed by gap key.", "type": "object" }, "source": { "description": "Where the record came from.", "enum": [ "plantilla", "tipo" ], "type": "string" }, "state": { "description": "Current state.", "enum": [ "DRAFTING", "REVIEW", "CONFIRMED", "DONE", "CANCELLED" ], "type": "string" }, "tipo": { "description": "Catalogue escrito tipo when source is tipo.", "type": [ "string", "null" ] }, "titulo": { "description": "Title.", "type": "string" } }, "required": [ "id", "source", "plantillaId", "tipo", "titulo", "state", "sharedValues", "createdById", "createdAt", "confirmedById", "confirmedAt", "requiereIA", "canal" ], "type": "object" }, "canManage": { "type": "boolean" }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Items per state.", "type": "object" }, "editable": { "type": "boolean" }, "filableCount": { "type": "integer" }, "generating": { "description": "Whether items are still pending or generating.", "type": "boolean" }, "items": { "description": "The records returned.", "items": { "properties": { "answers": { "additionalProperties": { "type": "string" }, "description": "Per-item gap answers, keyed by gap key.", "type": "object" }, "caratula": { "type": "string" }, "causaKind": { "enum": [ "bc", "pjud" ], "type": "string" }, "causaRef": { "description": "Id of the BC or PJUD causa.", "type": "string" }, "channels": { "description": "Filing channels of the item; empty until the batch is confirmed.", "items": { "properties": { "canal": { "enum": [ "bc", "pjud" ], "type": "string" }, "enabled": { "description": "False for a PJUD channel while PJUD filing is disabled for the organization.", "type": "boolean" }, "error": { "type": [ "string", "null" ] }, "folio": { "description": "Folio of a filed escrito, once known.", "type": [ "string", "null" ] }, "jobId": { "description": "Filing job id; empty when no job could be queued.", "type": "string" }, "numeroIngreso": { "description": "PJUD ingreso number of a filed escrito, once known.", "type": [ "string", "null" ] }, "state": { "description": "Filing job state (PENDING, CLAIMED, RUNNING, SUCCEEDED, FAILED, BLOCKED_DISABLED, CANCELLED).", "type": "string" }, "status": { "description": "Display status of the channel.", "enum": [ "pending", "sent", "error", "disabled", "" ], "type": "string" } }, "required": [ "canal", "enabled" ], "type": "object" }, "type": "array" }, "error": { "description": "Empty when there is no error.", "type": "string" }, "escritoKind": { "enum": [ "generic", "liquidador" ], "type": "string" }, "escritoRef": { "description": "Id of the generated escrito; empty until generated.", "type": "string" }, "filable": { "description": "Whether confirming the batch would file this item.", "type": "boolean" }, "hasPreview": { "type": "boolean" }, "id": { "description": "Unique identifier.", "type": "string" }, "missingFields": { "items": { "properties": { "clave": { "description": "Gap key.", "type": "string" }, "pregunta": { "description": "Question shown to the user.", "type": "string" }, "shared": { "description": "Whether the gap is answered once for the whole batch.", "type": "boolean" } }, "required": [ "clave", "pregunta", "shared" ], "type": "object" }, "type": "array" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "state": { "description": "Current state.", "enum": [ "PENDING", "GENERATING", "READY", "NEEDS_DATA", "ERROR", "EXCLUDED", "QUEUED", "FILED", "FAILED" ], "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "id", "causaRef", "causaKind", "rol", "tribunal", "caratula", "escritoKind", "escritoRef", "state", "error", "missingFields", "answers", "channels", "filable", "hasPreview" ], "type": "object" }, "type": "array" }, "pjudFilingEnabled": { "type": "boolean" }, "sharedGaps": { "description": "Shared gaps of the items in NEEDS_DATA, most common first.", "items": { "properties": { "clave": { "type": "string" }, "items": { "description": "Items waiting on this gap.", "type": "integer" }, "pregunta": { "type": "string" } }, "required": [ "clave", "pregunta", "items" ], "type": "object" }, "type": "array" } }, "required": [ "batch", "items", "counts", "sharedGaps", "filableCount", "pjudFilingEnabled", "editable", "generating", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get escrito batch", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/actions/writings/queries/get-escrito-batch-document": { "post": { "description": "Get escrito batch document\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-queries-get-escrito-batch-document", "requestBody": { "content": { "application/json": { "example": { "args": [ { "format": "", "itemId": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "format": { "type": "string" }, "itemId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "previewUrl": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "previewUrl": { "description": "Short-lived URL to preview the file.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get escrito batch document", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/actions/writings/queries/list-bulk-causes": { "post": { "description": "List bulk causas\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-queries-list-bulk-causes", "requestBody": { "content": { "application/json": { "example": { "args": [ { "estado": "", "kind": "", "procedimiento": "", "search": "", "source": "", "tribunal": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "estado": { "type": "string" }, "kind": { "type": "string" }, "procedimiento": { "type": "string" }, "search": { "type": "string" }, "source": { "type": "string" }, "tribunal": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "causas": [ { "ref": "string", "kind": "string", "id": "string", "causaId": "string", "rol": "string", "tribunal": "string", "caratula": "string", "procedimiento": "string", "estado": "string", "terminada": true } ], "total": 0, "truncated": true, "procedimientos": [ "string" ], "tribunales": [ "string" ], "maxCausas": 0, "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "canManage": { "type": "boolean" }, "causas": { "description": "PJUD causas.", "items": { "properties": { "caratula": { "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" }, "procedimiento": { "type": "string" }, "ref": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "terminada": { "type": "boolean" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "ref", "kind", "id", "causaId", "rol", "tribunal", "caratula", "procedimiento", "estado", "terminada" ], "type": "object" }, "type": "array" }, "maxCausas": { "type": "integer" }, "procedimientos": { "items": { "type": "string" }, "type": "array" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" }, "tribunales": { "items": { "type": "string" }, "type": "array" }, "truncated": { "type": "boolean" } }, "required": [ "causas", "total", "truncated", "procedimientos", "tribunales", "maxCausas", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List bulk causas", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/actions/writings/queries/list-escrito-batches": { "post": { "description": "List escrito batches\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-queries-list-escrito-batches", "requestBody": { "content": { "application/json": { "example": { "args": [] }, "schema": { "properties": { "args": {} }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "batches": [ { "id": "string", "source": "string", "plantillaId": "string", "tipo": "string", "titulo": "string", "state": "string", "createdAt": "2026-01-31T12:00:00Z", "confirmedAt": "2026-01-31T12:00:00Z", "total": 0, "counts": { "\u003ckey\u003e": 0 } } ], "plantillas": [ { "id": "string", "nombre": "string", "requiereIA": true, "canal": "bc", "instruccion": "string" } ], "tipos": [ { "tipo": "string", "label": "string", "labelEn": "string" } ], "maxCausas": 0, "canManage": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "batches": { "items": { "properties": { "confirmedAt": { "format": "date-time", "type": [ "string", "null" ] }, "counts": { "additionalProperties": { "type": "integer" }, "description": "Items per state (PENDING, READY, NEEDS_DATA, FILED, ...).", "type": "object" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "plantillaId": { "type": [ "string", "null" ] }, "source": { "description": "Where the record came from.", "type": "string" }, "state": { "description": "Current state.", "type": "string" }, "tipo": { "description": "Record type.", "type": [ "string", "null" ] }, "titulo": { "description": "Title.", "type": "string" }, "total": { "description": "Total number of matching records across all pages.", "type": [ "integer", "null" ] } }, "required": [ "id", "source", "plantillaId", "tipo", "titulo", "state", "createdAt", "confirmedAt", "total", "counts" ], "type": "object" }, "type": "array" }, "canManage": { "type": "boolean" }, "maxCausas": { "type": "integer" }, "plantillas": { "description": "The organization's escrito plantillas a batch can use.", "items": { "properties": { "canal": { "enum": [ "bc", "pjud", "auto" ], "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "instruccion": { "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "requiereIA": { "type": "boolean" } }, "required": [ "id", "nombre", "requiereIA", "canal", "instruccion" ], "type": "object" }, "type": "array" }, "tipos": { "description": "Catalogue escrito tipos enabled for batches.", "items": { "properties": { "label": { "description": "Spanish label.", "type": "string" }, "labelEn": { "description": "English label.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "tipo", "label", "labelEn" ], "type": "object" }, "type": "array" } }, "required": [ "batches", "plantillas", "tipos", "maxCausas", "canManage" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List escrito batches", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/actions/writings/queries/list-escrito-filings": { "post": { "description": "List escrito filings\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "operationId": "actions-writings-queries-list-escrito-filings", "requestBody": { "content": { "application/json": { "example": { "args": [ { "escritoKind": "", "escritoRefs": [], "state": "" } ] }, "schema": { "properties": { "args": { "items": { "properties": { "escritoKind": { "type": "string" }, "escritoRefs": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "filings": [ { "id": "string", "escritoKind": "generic", "escritoRef": "string", "causaId": "string", "canal": "bc", "state": "PENDING", "attempts": 0, "error": "string", "result": {}, "confirmedById": "string", "confirmedAt": "2026-01-31T12:00:00Z", "submitDispatchedAt": "2026-01-31T12:00:00Z", "boletinUploadJobId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z", "status": "pending" } ], "pjudFilingEnabled": true } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "filings": { "description": "Latest 500 filing jobs matching the filters, newest first.", "items": { "properties": { "attempts": { "description": "Number of attempts.", "type": "integer" }, "boletinUploadJobId": { "type": [ "string", "null" ] }, "canal": { "enum": [ "bc", "pjud" ], "type": "string" }, "causaId": { "description": "PJUD causa id (as returned by the causa endpoints).", "type": [ "string", "null" ] }, "confirmedAt": { "format": "date-time", "type": "string" }, "confirmedById": { "type": "string" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "error": { "type": [ "string", "null" ] }, "escritoKind": { "enum": [ "generic", "liquidador" ], "type": "string" }, "escritoRef": { "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "result": { "description": "Receipt of the filing as the channel returned it (folio, numeroIngreso, portalPubId, ...); {} until filed." }, "state": { "description": "Current state.", "enum": [ "PENDING", "CLAIMED", "RUNNING", "SUCCEEDED", "FAILED", "BLOCKED_DISABLED", "CANCELLED" ], "type": "string" }, "status": { "description": "Display status.", "enum": [ "pending", "sent", "error", "disabled" ], "type": "string" }, "submitDispatchedAt": { "description": "When the PJUD submit request was dispatched.", "format": "date-time", "type": [ "string", "null" ] }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" } }, "required": [ "id", "escritoKind", "escritoRef", "causaId", "canal", "state", "attempts", "error", "result", "confirmedById", "confirmedAt", "submitDispatchedAt", "boletinUploadJobId", "createdAt", "updatedAt", "status" ], "type": "object" }, "type": "array" }, "pjudFilingEnabled": { "type": "boolean" } }, "required": [ "filings", "pjudFilingEnabled" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "404": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Causa no encontrada en esta organización.", "errorCode": "NOT_FOUND", "message": "The requested resource does not exist in the API key's organization.", "messageEs": "Causa no encontrada en esta organización.", "status": 404 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "No se pudo completar la gestión.", "errorCode": "UNPROCESSABLE", "message": "The request was understood but could not be completed.", "messageEs": "No se pudo completar la gestión.", "status": 422 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Could not complete" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List escrito filings", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/assistant/cases": { "get": { "description": "Search organization cases for AI context\n\nAuthentication: developer API key with `ai:use` scope.", "operationId": "assistant-cases", "parameters": [ { "description": "The key's organization id.", "in": "query", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "description": "Case search text.", "in": "query", "name": "q", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "cases": [ { "id": "string", "rol": "string", "title": "string", "kind": "tracked" } ] }, "schema": { "properties": { "cases": { "description": "Up to 20 matches, most recently updated first.", "items": { "properties": { "id": { "description": "Unique identifier.", "type": "string" }, "kind": { "description": "tracked: a PJUD causa id; internal: an internal expediente id.", "enum": [ "tracked", "internal" ], "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "title": { "description": "Caratulado; empty when unknown.", "type": "string" } }, "required": [ "id", "rol", "title", "kind" ], "type": "object" }, "type": "array" } }, "required": [ "cases" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search organization cases for AI context", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/assistant/chat": { "post": { "description": "Chat with the legal AI assistant\n\nAuthentication: developer API key with `ai:use` scope. Send `Accept: text/event-stream` for streaming responses. AI usage may be metered.", "operationId": "assistant-chat", "requestBody": { "content": { "application/json": { "example": { "messages": "\u003cmessages\u003e" }, "schema": { "properties": { "messages": {} }, "required": [ "messages" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "answer": "string", "sources": [ { "kind": "ley", "ref": "string", "title": "string", "url": "string", "snippet": "string", "score": 0 } ], "model": "string", "warnings": [ "string" ], "conversationId": "string", "messageId": "string" }, "schema": { "properties": { "answer": { "type": "string" }, "conversationId": { "description": "Saved conversation; absent when the turn was not saved.", "type": "string" }, "messageId": { "description": "Saved turn id; absent when the turn was not saved.", "type": "string" }, "model": { "description": "Model that wrote the answer.", "type": "string" }, "sources": { "description": "Sources the answer was grounded on; null when none were retrieved.", "items": { "properties": { "kind": { "description": "Record subtype.", "enum": [ "ley", "jurisprudencia", "administrativo", "organizacion", "modelo" ], "type": "string" }, "ref": { "description": "Source reference (law id, juris id, organization record).", "type": "string" }, "score": { "description": "Retrieval relevance score.", "type": "number" }, "snippet": { "type": "string" }, "title": { "description": "Title.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "kind", "ref", "title", "snippet", "score" ], "type": "object" }, "type": [ "array", "null" ] }, "warnings": { "description": "Sources that could not be consulted for this turn.", "items": { "type": "string" }, "type": "array" } }, "required": [ "answer", "sources", "model" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Chat with the legal AI assistant", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/assistant/instructions": { "get": { "description": "Read organization AI instructions\n\nAuthentication: developer API key with `ai:use` scope.", "operationId": "assistant-instructions", "responses": { "200": { "content": { "application/json": { "example": { "organizationId": "string", "organizationName": "string", "canEdit": true, "organizationContextEnabled": true, "state": { "version": 0, "files": [ { "name": "string", "content": "string", "enabled": true } ], "updatedBy": "string", "updatedAt": "2026-01-31T12:00:00Z" } }, "schema": { "properties": { "canEdit": { "description": "Whether the caller may edit the instructions.", "type": "boolean" }, "organizationContextEnabled": { "description": "Whether organization data may be sent to the assistant on this deployment.", "type": "boolean" }, "organizationId": { "type": "string" }, "organizationName": { "description": "Organization name.", "type": "string" }, "state": { "description": "Current state.", "properties": { "files": { "description": "Instruction files added to the assistant's prompt.", "items": { "properties": { "content": { "description": "Content.", "type": "string" }, "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "name", "content", "enabled" ], "type": "object" }, "type": "array" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "updatedBy": { "description": "User id of the last editor.", "type": "string" }, "version": { "description": "Optimistic-lock version; a PUT must send the version it edited.", "type": "integer" } }, "required": [ "version", "files" ], "type": "object" } }, "required": [ "organizationId", "organizationName", "canEdit", "organizationContextEnabled", "state" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Read organization AI instructions", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/assistant/task-draft": { "post": { "description": "Draft a task from a case movement\n\nAuthentication: developer API key with `ai:use` scope. AI usage may be metered.", "operationId": "assistant-task-draft", "requestBody": { "content": { "application/json": { "example": { "causaId": "\u003ccausaId\u003e", "sourceId": "\u003csourceId\u003e", "sourceType": "\u003csourceType\u003e" }, "schema": { "properties": { "causaId": { "type": "string" }, "sourceId": { "type": "string" }, "sourceType": { "type": "string" } }, "required": [ "causaId", "sourceId", "sourceType" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "title": "string", "description": "string" }, "schema": { "properties": { "description": { "description": "Proposed task description (up to 4000 characters).", "type": "string" }, "title": { "description": "Proposed task title (up to 200 characters).", "type": "string" } }, "required": [ "title", "description" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"ai:use\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"ai:use\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "ai:use", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Draft a task from a case movement", "tags": [ "Artificial intelligence" ], "x-required-scope": "ai:use" } }, "/api/case-activity/documents/archive": { "get": { "description": "Download case activity documents as an archive\n\nAuthentication: developer API key with `cases:read` scope. Results follow the key owner's case visibility.", "operationId": "case-activity-documents-archive", "parameters": [ { "description": "Document-bearing activity section.", "in": "query", "name": "section", "required": true, "schema": { "type": "string" } }, { "description": "Start date.", "in": "query", "name": "from", "required": false, "schema": { "type": "string" } }, { "description": "End date.", "in": "query", "name": "to", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (file)" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download case activity documents as an archive", "tags": [ "Expedientes and activity" ], "x-required-scope": "cases:read" } }, "/api/case-activity/exports/download": { "get": { "description": "Download a completed case activity export\n\nAuthentication: developer API key with `cases:read` scope. Only exports requested by the key owner are available.", "operationId": "case-activity-exports-download", "parameters": [ { "description": "Export job id.", "in": "query", "name": "jobId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (file)" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download a completed case activity export", "tags": [ "Expedientes and activity" ], "x-required-scope": "cases:read" } }, "/api/case-law/document": { "get": { "description": "Get one ruling\n\nAuthentication: developer API key. One canonical case-law record, including its full text. An id that exists in several buscadores answers 409 {\"error\":\"Ambiguous jurisId\",\"buscadores\":[...]} unless buscador is given. Billed per ruling (CASE_LAW_DOCUMENT) beyond the monthly allowance, and counts one against the daily case-law quota; a 404 is neither billed nor counted.", "operationId": "case-law-document", "parameters": [ { "description": "Case-law identifier.", "in": "query", "name": "jurisId", "required": true, "schema": { "type": "string" } }, { "description": "Collection the ruling belongs to (list items carry it). PJUD reuses ids across buscadores; required when the id is ambiguous (409).", "in": "query", "name": "buscador", "required": false, "schema": { "enum": [ "CORTE_SUPREMA", "CORTES_APELACIONES", "LABORAL", "PENAL", "FAMILIA", "COBRANZA", "CIVIL", "LINEAS_JURISPRUDENCIALES", "SALUD_CS", "COMPENDIO_EXTRANJERIA" ], "type": "string" } }, { "description": "Include raw HTML fields.", "in": "query", "name": "includeHtml", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "jurisId": "string", "buscador": "CORTE_SUPREMA", "caratulado": "string", "caratuladoAnon": "string", "corte": "string", "sala": "string", "rolEraApe": "string", "resultadoRecurso": "string", "fecSentenciaSup": "2026-01-31T12:00:00Z", "urlAccesoSentencia": "string", "urlCortaAccesoSentencia": "string", "citaBibliografica": "string", "privilegio": "string", "titulo": "string", "tribunal": "string", "rol": "string", "materia": "string", "origen": "string", "resultado": "string", "descriptores": [ "string" ], "normas": [ "string" ], "ministros": [ "string" ], "redactor": "string", "textoSentenciaText": "string", "textoSentenciaAnonText": "string", "textoSentenciaHtml": "string", "textoSentenciaAnonHtml": "string", "textoSentenciaPreview": "string" }, "schema": { "properties": { "buscador": { "description": "Collection the ruling belongs to.", "enum": [ "CORTE_SUPREMA", "CORTES_APELACIONES", "LABORAL", "PENAL", "FAMILIA", "COBRANZA", "CIVIL", "LINEAS_JURISPRUDENCIALES", "SALUD_CS", "COMPENDIO_EXTRANJERIA" ], "type": "string" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "caratuladoAnon": { "description": "Anonymized caption.", "type": "string" }, "citaBibliografica": { "description": "Bibliographic citation.", "type": "string" }, "corte": { "description": "Raw PJUD court field; on Corte Suprema rulings it is the court of origin.", "type": "string" }, "descriptores": { "description": "PJUD subject descriptors (Corte Suprema).", "items": { "type": "string" }, "type": "array" }, "fecSentenciaSup": { "description": "Ruling date.", "format": "date-time", "type": "string" }, "jurisId": { "description": "Case-law identifier; unique together with buscador.", "type": "string" }, "materia": { "description": "Recurso type or case subject.", "type": "string" }, "ministros": { "items": { "type": "string" }, "type": "array" }, "normas": { "description": "Cited articles (Corte Suprema).", "items": { "type": "string" }, "type": "array" }, "origen": { "description": "Lower court the case came from, with its rol when known.", "type": "string" }, "privilegio": { "description": "PJUD privilege label; informational, not an access restriction.", "type": "string" }, "redactor": { "type": "string" }, "resultado": { "description": "Outcome, without the recurso type.", "type": "string" }, "resultadoRecurso": { "description": "Outcome of the appeal.", "type": "string" }, "rol": { "description": "The ruling's own docket in tribunal.", "type": "string" }, "rolEraApe": { "description": "Raw PJUD rol field; on Corte Suprema rulings it is the rol of origin.", "type": "string" }, "sala": { "description": "Court chamber (sala).", "type": "string" }, "textoSentenciaAnonHtml": { "description": "Raw anonymized HTML text (includeHtml=true).", "type": "string" }, "textoSentenciaAnonText": { "description": "Anonymized full ruling text.", "type": "string" }, "textoSentenciaHtml": { "description": "Raw HTML text (includeHtml=true).", "type": "string" }, "textoSentenciaPreview": { "description": "Opening of the ruling as PJUD shows it anonymously; set only when no full text is stored.", "type": "string" }, "textoSentenciaText": { "description": "Full ruling text.", "type": "string" }, "titulo": { "description": "Display caption.", "type": "string" }, "tribunal": { "description": "Court that issued the ruling.", "type": "string" }, "urlAccesoSentencia": { "description": "URL of the ruling at PJUD.", "format": "uri", "type": "string" }, "urlCortaAccesoSentencia": { "description": "Short URL of the ruling at PJUD.", "format": "uri", "type": "string" } }, "required": [ "jurisId", "buscador" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get one ruling", "tags": [ "Case law" ] } }, "/api/case-law/documents": { "get": { "description": "List case-law rulings\n\nAuthentication: developer API key. Canonical case-law summaries with filters and keyset pagination. Counts against the daily case-law quota as one ruling per 20 rows returned.", "operationId": "case-law-documents", "parameters": [ { "description": "Source.", "in": "query", "name": "buscador", "required": false, "schema": { "enum": [ "CORTE_SUPREMA", "CORTES_APELACIONES", "LABORAL", "PENAL", "FAMILIA", "COBRANZA", "CIVIL", "LINEAS_JURISPRUDENCIALES", "SALUD_CS", "COMPENDIO_EXTRANJERIA" ], "type": "string" } }, { "description": "Free-text filter.", "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "description": "Start date, YYYY-MM-DD.", "in": "query", "name": "dateFrom", "required": false, "schema": { "type": "string" } }, { "description": "End date, YYYY-MM-DD.", "in": "query", "name": "dateTo", "required": false, "schema": { "type": "string" } }, { "description": "Page number (default 1).", "in": "query", "name": "page", "required": false, "schema": { "type": "number" } }, { "description": "Rows per page (max 100).", "in": "query", "name": "pageSize", "required": false, "schema": { "type": "number" } }, { "description": "Include the total count (slower). Text-search totals stop at 1000: the response then carries totalCapped=true and totalPages 0.", "in": "query", "name": "includeTotal", "required": false, "schema": { "type": "boolean" } }, { "description": "Opaque cursor from a previous page's nextCursor.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "page": 0, "pageSize": 0, "total": 0, "totalPages": 0, "totalCapped": true, "items": [ { "jurisId": "string", "buscador": "CORTE_SUPREMA", "caratulado": "string", "caratuladoAnon": "string", "corte": "string", "sala": "string", "rolEraApe": "string", "resultadoRecurso": "string", "fecSentenciaSup": "2026-01-31T12:00:00Z", "urlAccesoSentencia": "string", "urlCortaAccesoSentencia": "string", "citaBibliografica": "string", "privilegio": "string", "snippet": "string", "titulo": "string", "tribunal": "string", "rol": "string", "materia": "string", "origen": "string", "resultado": "string", "descriptores": [ "string" ] } ], "nextCursor": "string", "hasMore": true }, "schema": { "properties": { "hasMore": { "type": "boolean" }, "items": { "description": "The records returned.", "items": { "properties": { "buscador": { "description": "Collection the ruling belongs to.", "enum": [ "CORTE_SUPREMA", "CORTES_APELACIONES", "LABORAL", "PENAL", "FAMILIA", "COBRANZA", "CIVIL", "LINEAS_JURISPRUDENCIALES", "SALUD_CS", "COMPENDIO_EXTRANJERIA" ], "type": "string" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "caratuladoAnon": { "description": "Anonymized caption.", "type": "string" }, "citaBibliografica": { "description": "Bibliographic citation.", "type": "string" }, "corte": { "description": "Raw PJUD court field; on Corte Suprema rulings it is the court of origin.", "type": "string" }, "descriptores": { "description": "PJUD subject descriptors (Corte Suprema).", "items": { "type": "string" }, "type": "array" }, "fecSentenciaSup": { "description": "Ruling date.", "format": "date-time", "type": "string" }, "jurisId": { "description": "Case-law identifier; unique together with buscador.", "type": "string" }, "materia": { "description": "Recurso type or case subject.", "type": "string" }, "origen": { "description": "Lower court the case came from, with its rol when known.", "type": "string" }, "privilegio": { "description": "PJUD privilege label; informational, not an access restriction.", "type": "string" }, "resultado": { "description": "Outcome, without the recurso type.", "type": "string" }, "resultadoRecurso": { "description": "Outcome of the appeal.", "type": "string" }, "rol": { "description": "The ruling's own docket in tribunal.", "type": "string" }, "rolEraApe": { "description": "Raw PJUD rol field; on Corte Suprema rulings it is the rol of origin.", "type": "string" }, "sala": { "description": "Court chamber (sala).", "type": "string" }, "snippet": { "description": "Short excerpt of the ruling text.", "type": "string" }, "titulo": { "description": "Display caption.", "type": "string" }, "tribunal": { "description": "Court that issued the ruling.", "type": "string" }, "urlAccesoSentencia": { "description": "URL of the ruling at PJUD.", "format": "uri", "type": "string" }, "urlCortaAccesoSentencia": { "description": "Short URL of the ruling at PJUD.", "format": "uri", "type": "string" } }, "required": [ "jurisId", "buscador" ], "type": "object" }, "type": "array" }, "nextCursor": { "description": "Opaque cursor for the next page.", "type": "string" }, "page": { "description": "Current page number (1-based).", "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "description": "Matching rows; 0 unless includeTotal=true.", "type": "integer" }, "totalCapped": { "description": "total is a lower bound (text-search counts stop at 1000).", "type": "boolean" }, "totalPages": { "description": "0 unless includeTotal=true, and 0 when totalCapped.", "type": "integer" } }, "required": [ "page", "pageSize", "total", "totalPages", "items" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List case-law rulings", "tags": [ "Case law" ] } }, "/api/case-tracking/documents/view": { "get": { "description": "Download a tracked case document\n\nAuthentication: developer API key with `cases:read` scope. The document must belong to a case visible to the key's organization.", "operationId": "case-tracking-documents-view", "parameters": [ { "description": "Organization-visible tracked case id.", "in": "query", "name": "caseId", "required": true, "schema": { "type": "string" } }, { "description": "Document storage path from case data.", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (file)" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"cases:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"cases:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "cases:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Download a tracked case document", "tags": [ "Expedientes and activity" ], "x-required-scope": "cases:read" } }, "/api/developer-data/liquidaciones/causas": { "get": { "description": "List the organization's liquidador causas\n\nAuthentication: developer API key. Boletín Concursal causas where the organization acts as liquidador.", "operationId": "developer-data-liquidaciones-causas", "parameters": [ { "description": "Partial match on rol, name or debtor RUT.", "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "description": "Page number (default 1).", "in": "query", "name": "page", "required": false, "schema": { "type": "number" } }, { "description": "Rows per page (default 50).", "in": "query", "name": "perPage", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "example": { "page": 0, "perPage": 0, "total": 0, "pageCount": 0, "causas": [ { "id": "string", "documentId": "string", "rol": "string", "nombre": "string", "estado": "string", "deudorRut": "string", "tribunal": "string", "liquidador": "string", "tipoProcedimiento": "string", "ultimaGestion": "string", "fechaUltimaGestion": "string", "cantidadGestiones": 0, "region": "string", "rolSujeto": "string", "sujetoTitular": "string", "veedorAsociado": "string", "tieneMartilleros": true, "liquidadorAsociado": true, "fecha": "string", "createdAt": "string", "updatedAt": "string" } ] }, "schema": { "properties": { "causas": { "description": "Newest procedimiento first.", "items": { "properties": { "cantidadGestiones": { "description": "Number of collection actions.", "type": [ "integer", "null" ] }, "createdAt": { "description": "Timestamp without UTC offset (ISO 8601, e.g. 2026-10-01T00:00:00), as stored.", "type": "string" }, "deudorRut": { "description": "Debtor's RUT.", "type": [ "string", "null" ] }, "documentId": { "description": "Boletín Concursal procedimiento id.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fecha": { "description": "Procedimiento date. Timestamp without UTC offset (ISO 8601, e.g. 2026-10-01T00:00:00), as stored.", "type": [ "string", "null" ] }, "fechaUltimaGestion": { "description": "Timestamp without UTC offset (ISO 8601, e.g. 2026-10-01T00:00:00), as stored.", "type": [ "string", "null" ] }, "id": { "description": "Unique identifier.", "type": "string" }, "liquidador": { "type": [ "string", "null" ] }, "liquidadorAsociado": { "type": "boolean" }, "nombre": { "description": "Debtor name.", "type": [ "string", "null" ] }, "region": { "description": "Chilean region.", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "rolSujeto": { "type": [ "string", "null" ] }, "sujetoTitular": { "type": [ "string", "null" ] }, "tieneMartilleros": { "type": "boolean" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] }, "tribunal": { "description": "Court name.", "type": [ "string", "null" ] }, "ultimaGestion": { "description": "Last collection action (ISO 8601).", "type": [ "string", "null" ] }, "updatedAt": { "description": "Timestamp without UTC offset (ISO 8601, e.g. 2026-10-01T00:00:00), as stored.", "type": "string" }, "veedorAsociado": { "type": [ "string", "null" ] } }, "required": [ "id", "documentId", "rol", "nombre", "estado", "deudorRut", "tribunal", "liquidador", "tipoProcedimiento", "ultimaGestion", "fechaUltimaGestion", "cantidadGestiones", "region", "rolSujeto", "sujetoTitular", "veedorAsociado", "tieneMartilleros", "liquidadorAsociado", "fecha", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "page": { "description": "Current page number (1-based).", "type": "integer" }, "pageCount": { "description": "Number of pages at the requested page size.", "type": "integer" }, "perPage": { "description": "Page size.", "type": "integer" }, "total": { "description": "Total number of matching records across all pages.", "type": "integer" } }, "required": [ "page", "perPage", "total", "pageCount", "causas" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List the organization's liquidador causas", "tags": [ "Liquidations" ] } }, "/api/developer/webhooks": { "get": { "description": "List webhook endpoints\n\nAuthentication: developer API key with `webhooks:read` scope. Returns the key organization's endpoints (never their secrets), the subscribable event types and the per-organization endpoint limit.", "operationId": "developer-webhooks", "responses": { "200": { "content": { "application/json": { "example": { "orgId": "string", "count": 0, "items": [ { "id": "string", "orgId": "string", "url": "string", "description": "string", "eventTypes": [ "string" ], "secretPrefix": "string", "enabled": true, "disabledAt": "2026-01-31T12:00:00Z", "disabledReason": "manual", "consecutiveFailures": 0, "lastSuccessAt": "2026-01-31T12:00:00Z", "lastFailureAt": "2026-01-31T12:00:00Z", "createdByUserId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "eventTypes": [ { "name": "string", "descriptionEs": "string", "descriptionEn": "string" } ], "maxEndpoints": 0, "endpoint": { "id": "string", "orgId": "string", "url": "string", "description": "string", "eventTypes": [ "string" ], "secretPrefix": "string", "enabled": true, "disabledAt": "2026-01-31T12:00:00Z", "disabledReason": "manual", "consecutiveFailures": 0, "lastSuccessAt": "2026-01-31T12:00:00Z", "lastFailureAt": "2026-01-31T12:00:00Z", "createdByUserId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" }, "secretSource": "generated", "secret": "string" }, "schema": { "properties": { "count": { "description": "GET only.", "type": "integer" }, "endpoint": { "description": "POST only (201): the created endpoint.", "properties": { "consecutiveFailures": { "type": "integer" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdByUserId": { "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "disabledAt": { "format": "date-time", "type": [ "string", "null" ] }, "disabledReason": { "description": "Why the endpoint is disabled: by a user, or automatically after repeated delivery failures.", "enum": [ "manual", "failing" ], "type": [ "string", "null" ] }, "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" }, "eventTypes": { "description": "Subscribed event names; empty means every event.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Endpoint id.", "type": "string" }, "lastFailureAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastSuccessAt": { "format": "date-time", "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "secretPrefix": { "description": "First characters of the signing secret (12 for a generated whsec_ secret, 4 for your own), to tell secrets apart.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "id", "orgId", "url", "description", "eventTypes", "secretPrefix", "enabled", "disabledAt", "disabledReason", "consecutiveFailures", "lastSuccessAt", "lastFailureAt", "createdByUserId", "createdAt", "updatedAt" ], "type": "object" }, "eventTypes": { "description": "GET only: the subscribable events.", "items": { "properties": { "descriptionEn": { "type": "string" }, "descriptionEs": { "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "name", "descriptionEs", "descriptionEn" ], "type": "object" }, "type": "array" }, "items": { "description": "GET only: the organization's endpoints, newest first, never their secrets.", "items": { "properties": { "consecutiveFailures": { "type": "integer" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdByUserId": { "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "disabledAt": { "format": "date-time", "type": [ "string", "null" ] }, "disabledReason": { "description": "Why the endpoint is disabled: by a user, or automatically after repeated delivery failures.", "enum": [ "manual", "failing" ], "type": [ "string", "null" ] }, "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" }, "eventTypes": { "description": "Subscribed event names; empty means every event.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Endpoint id.", "type": "string" }, "lastFailureAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastSuccessAt": { "format": "date-time", "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "secretPrefix": { "description": "First characters of the signing secret (12 for a generated whsec_ secret, 4 for your own), to tell secrets apart.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "id", "orgId", "url", "description", "eventTypes", "secretPrefix", "enabled", "disabledAt", "disabledReason", "consecutiveFailures", "lastSuccessAt", "lastFailureAt", "createdByUserId", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "maxEndpoints": { "description": "GET only: endpoint limit per organization.", "type": "integer" }, "orgId": { "description": "GET only.", "type": "string" }, "secret": { "description": "The generated signing secret (whsec_…), returned only once, only when secretSource is generated.", "type": "string" }, "secretSource": { "description": "POST only. generated: Nexulex created the secret and returns it in secret; custom: your own secret, never echoed.", "enum": [ "generated", "custom" ], "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"webhooks:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"webhooks:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "webhooks:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List webhook endpoints", "tags": [ "Webhooks" ], "x-required-scope": "webhooks:read" }, "post": { "description": "Create a webhook endpoint\n\nAuthentication: developer API key with `webhooks:write` scope. Without `secret`, Nexulex generates one and returns it in the response, only once. With your own `secret` the response omits it (`secretSource: custom`). Endpoints receive organization-wide events regardless of the key's acting role.", "operationId": "developer-webhooks", "requestBody": { "content": { "application/json": { "example": { "url": "\u003curl\u003e" }, "schema": { "properties": { "description": { "type": "string" }, "eventTypes": {}, "secret": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "orgId": "string", "count": 0, "items": [ { "id": "string", "orgId": "string", "url": "string", "description": "string", "eventTypes": [ "string" ], "secretPrefix": "string", "enabled": true, "disabledAt": "2026-01-31T12:00:00Z", "disabledReason": "manual", "consecutiveFailures": 0, "lastSuccessAt": "2026-01-31T12:00:00Z", "lastFailureAt": "2026-01-31T12:00:00Z", "createdByUserId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } ], "eventTypes": [ { "name": "string", "descriptionEs": "string", "descriptionEn": "string" } ], "maxEndpoints": 0, "endpoint": { "id": "string", "orgId": "string", "url": "string", "description": "string", "eventTypes": [ "string" ], "secretPrefix": "string", "enabled": true, "disabledAt": "2026-01-31T12:00:00Z", "disabledReason": "manual", "consecutiveFailures": 0, "lastSuccessAt": "2026-01-31T12:00:00Z", "lastFailureAt": "2026-01-31T12:00:00Z", "createdByUserId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" }, "secretSource": "generated", "secret": "string" }, "schema": { "properties": { "count": { "description": "GET only.", "type": "integer" }, "endpoint": { "description": "POST only (201): the created endpoint.", "properties": { "consecutiveFailures": { "type": "integer" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdByUserId": { "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "disabledAt": { "format": "date-time", "type": [ "string", "null" ] }, "disabledReason": { "description": "Why the endpoint is disabled: by a user, or automatically after repeated delivery failures.", "enum": [ "manual", "failing" ], "type": [ "string", "null" ] }, "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" }, "eventTypes": { "description": "Subscribed event names; empty means every event.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Endpoint id.", "type": "string" }, "lastFailureAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastSuccessAt": { "format": "date-time", "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "secretPrefix": { "description": "First characters of the signing secret (12 for a generated whsec_ secret, 4 for your own), to tell secrets apart.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "id", "orgId", "url", "description", "eventTypes", "secretPrefix", "enabled", "disabledAt", "disabledReason", "consecutiveFailures", "lastSuccessAt", "lastFailureAt", "createdByUserId", "createdAt", "updatedAt" ], "type": "object" }, "eventTypes": { "description": "GET only: the subscribable events.", "items": { "properties": { "descriptionEn": { "type": "string" }, "descriptionEs": { "type": "string" }, "name": { "description": "Display name.", "type": "string" } }, "required": [ "name", "descriptionEs", "descriptionEn" ], "type": "object" }, "type": "array" }, "items": { "description": "GET only: the organization's endpoints, newest first, never their secrets.", "items": { "properties": { "consecutiveFailures": { "type": "integer" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdByUserId": { "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "disabledAt": { "format": "date-time", "type": [ "string", "null" ] }, "disabledReason": { "description": "Why the endpoint is disabled: by a user, or automatically after repeated delivery failures.", "enum": [ "manual", "failing" ], "type": [ "string", "null" ] }, "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" }, "eventTypes": { "description": "Subscribed event names; empty means every event.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Endpoint id.", "type": "string" }, "lastFailureAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastSuccessAt": { "format": "date-time", "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "secretPrefix": { "description": "First characters of the signing secret (12 for a generated whsec_ secret, 4 for your own), to tell secrets apart.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "id", "orgId", "url", "description", "eventTypes", "secretPrefix", "enabled", "disabledAt", "disabledReason", "consecutiveFailures", "lastSuccessAt", "lastFailureAt", "createdByUserId", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "maxEndpoints": { "description": "GET only: endpoint limit per organization.", "type": "integer" }, "orgId": { "description": "GET only.", "type": "string" }, "secret": { "description": "The generated signing secret (whsec_…), returned only once, only when secretSource is generated.", "type": "string" }, "secretSource": { "description": "POST only. generated: Nexulex created the secret and returns it in secret; custom: your own secret, never echoed.", "enum": [ "generated", "custom" ], "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"webhooks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"webhooks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "webhooks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a webhook endpoint", "tags": [ "Webhooks" ], "x-modifies-data": true, "x-required-scope": "webhooks:write" } }, "/api/developer/webhooks/delete": { "post": { "description": "Delete a webhook endpoint\n\nAuthentication: developer API key with `webhooks:write` scope. Deletes the endpoint and its delivery history.", "operationId": "developer-webhooks-delete", "requestBody": { "content": { "application/json": { "example": { "id": "\u003cid\u003e" }, "schema": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "deleted": true, "id": "string" }, "schema": { "properties": { "deleted": { "description": "Always true.", "type": "boolean" }, "id": { "description": "Deleted endpoint id.", "type": "string" } }, "required": [ "deleted", "id" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"webhooks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"webhooks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "webhooks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Delete a webhook endpoint", "tags": [ "Webhooks" ], "x-modifies-data": true, "x-required-scope": "webhooks:write" } }, "/api/developer/webhooks/deliveries": { "get": { "description": "List an endpoint's deliveries\n\nAuthentication: developer API key with `webhooks:read` scope. Newest first, kept for 30 days.", "operationId": "developer-webhooks-deliveries", "parameters": [ { "description": "Endpoint id.", "in": "query", "name": "endpointId", "required": true, "schema": { "type": "string" } }, { "description": "Filter by status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "PENDING", "SUCCEEDED", "FAILED" ], "type": "string" } }, { "description": "Up to 100 (default 50).", "in": "query", "name": "limit", "required": false, "schema": { "type": "number" } }, { "description": "RFC 3339 cursor: deliveries created before this time.", "in": "query", "name": "before", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "endpointId": "string", "count": 0, "items": [ { "id": "string", "endpointId": "string", "eventId": "string", "eventType": "string", "status": "PENDING", "attempts": 0, "lastStatusCode": 0, "lastError": "string", "lastDurationMs": 0, "nextAttemptAt": "2026-01-31T12:00:00Z", "deliveredAt": "2026-01-31T12:00:00Z", "createdAt": "2026-01-31T12:00:00Z", "payload": { "id": "string", "type": "string", "createdAt": "2026-01-31T12:00:00Z", "orgId": "string", "data": {} } } ] }, "schema": { "properties": { "count": { "description": "Number of records.", "type": "integer" }, "endpointId": { "type": "string" }, "items": { "description": "Newest first.", "items": { "properties": { "attempts": { "description": "Number of attempts.", "type": "integer" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "deliveredAt": { "format": "date-time", "type": [ "string", "null" ] }, "endpointId": { "type": "string" }, "eventId": { "description": "Event id; sent as the Nexulex-Webhook-Id header.", "type": "string" }, "eventType": { "description": "Event type.", "type": "string" }, "id": { "description": "Delivery id.", "type": "string" }, "lastDurationMs": { "type": [ "integer", "null" ] }, "lastError": { "description": "Last error message; null when the last attempt succeeded.", "type": [ "string", "null" ] }, "lastStatusCode": { "description": "HTTP status of the last attempt.", "type": [ "integer", "null" ] }, "nextAttemptAt": { "description": "Next attempt; set only while PENDING.", "format": "date-time", "type": [ "string", "null" ] }, "payload": { "description": "The event body exactly as POSTed to the endpoint.", "properties": { "createdAt": { "description": "When the event happened.", "format": "date-time", "type": "string" }, "data": { "description": "Event data; its fields depend on the event type." }, "id": { "description": "Event id.", "type": "string" }, "orgId": { "description": "Organization id.", "type": "string" }, "type": { "description": "Event name.", "type": "string" } }, "required": [ "id", "type", "createdAt", "orgId", "data" ], "type": "object" }, "status": { "description": "Current status.", "enum": [ "PENDING", "SUCCEEDED", "FAILED" ], "type": "string" } }, "required": [ "id", "endpointId", "eventId", "eventType", "status", "attempts", "lastStatusCode", "lastError", "lastDurationMs", "nextAttemptAt", "deliveredAt", "createdAt", "payload" ], "type": "object" }, "type": "array" } }, "required": [ "endpointId", "count", "items" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"webhooks:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"webhooks:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "webhooks:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "List an endpoint's deliveries", "tags": [ "Webhooks" ], "x-required-scope": "webhooks:read" } }, "/api/developer/webhooks/redeliver": { "post": { "description": "Redeliver an event\n\nAuthentication: developer API key with `webhooks:write` scope. Queues the delivery again with a fresh retry budget and the same Nexulex-Webhook-Id.", "operationId": "developer-webhooks-redeliver", "requestBody": { "content": { "application/json": { "example": { "deliveryId": "\u003cdeliveryId\u003e" }, "schema": { "properties": { "deliveryId": { "type": "string" } }, "required": [ "deliveryId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "queued": true, "deliveryId": "string" }, "schema": { "properties": { "deliveryId": { "type": "string" }, "queued": { "description": "False when the delivery is being attempted right now (it is not queued twice).", "type": "boolean" } }, "required": [ "queued", "deliveryId" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"webhooks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"webhooks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "webhooks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Redeliver an event", "tags": [ "Webhooks" ], "x-modifies-data": true, "x-required-scope": "webhooks:write" } }, "/api/developer/webhooks/rotate-secret": { "post": { "description": "Rotate a webhook signing secret\n\nAuthentication: developer API key with `webhooks:write` scope. Replaces the secret with `secret` or, without it, a generated one returned once. The previous secret stops signing immediately.", "operationId": "developer-webhooks-rotate-secret", "requestBody": { "content": { "application/json": { "example": { "id": "\u003cid\u003e" }, "schema": { "properties": { "id": { "type": "string" }, "secret": { "type": "string" } }, "required": [ "id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "endpoint": { "id": "string", "orgId": "string", "url": "string", "description": "string", "eventTypes": [ "string" ], "secretPrefix": "string", "enabled": true, "disabledAt": "2026-01-31T12:00:00Z", "disabledReason": "manual", "consecutiveFailures": 0, "lastSuccessAt": "2026-01-31T12:00:00Z", "lastFailureAt": "2026-01-31T12:00:00Z", "createdByUserId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" }, "secretSource": "generated", "secret": "string" }, "schema": { "properties": { "endpoint": { "properties": { "consecutiveFailures": { "type": "integer" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdByUserId": { "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "disabledAt": { "format": "date-time", "type": [ "string", "null" ] }, "disabledReason": { "description": "Why the endpoint is disabled: by a user, or automatically after repeated delivery failures.", "enum": [ "manual", "failing" ], "type": [ "string", "null" ] }, "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" }, "eventTypes": { "description": "Subscribed event names; empty means every event.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Endpoint id.", "type": "string" }, "lastFailureAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastSuccessAt": { "format": "date-time", "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "secretPrefix": { "description": "First characters of the signing secret (12 for a generated whsec_ secret, 4 for your own), to tell secrets apart.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "id", "orgId", "url", "description", "eventTypes", "secretPrefix", "enabled", "disabledAt", "disabledReason", "consecutiveFailures", "lastSuccessAt", "lastFailureAt", "createdByUserId", "createdAt", "updatedAt" ], "type": "object" }, "secret": { "description": "The generated signing secret (whsec_…), returned only once, only when secretSource is generated.", "type": "string" }, "secretSource": { "description": "generated: Nexulex created the secret and returns it in secret; custom: your own secret, never echoed.", "enum": [ "generated", "custom" ], "type": "string" } }, "required": [ "endpoint", "secretSource" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"webhooks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"webhooks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "webhooks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Rotate a webhook signing secret", "tags": [ "Webhooks" ], "x-modifies-data": true, "x-required-scope": "webhooks:write" } }, "/api/developer/webhooks/test": { "post": { "description": "Send a test event\n\nAuthentication: developer API key with `webhooks:write` scope. Queues a `webhook.test` event to the endpoint; check its deliveries a few seconds later.", "operationId": "developer-webhooks-test", "requestBody": { "content": { "application/json": { "example": { "id": "\u003cid\u003e" }, "schema": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "queued": true, "deliveryId": "string", "eventId": "string" }, "schema": { "properties": { "deliveryId": { "type": "string" }, "eventId": { "description": "Test event id (test_…).", "type": "string" }, "queued": { "description": "Always true.", "type": "boolean" } }, "required": [ "queued", "deliveryId", "eventId" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"webhooks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"webhooks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "webhooks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Send a test event", "tags": [ "Webhooks" ], "x-modifies-data": true, "x-required-scope": "webhooks:write" } }, "/api/developer/webhooks/update": { "post": { "description": "Update a webhook endpoint\n\nAuthentication: developer API key with `webhooks:write` scope. Only the fields sent change. Re-enabling clears the failure counter.", "operationId": "developer-webhooks-update", "requestBody": { "content": { "application/json": { "example": { "id": "\u003cid\u003e" }, "schema": { "properties": { "description": { "type": "string" }, "enabled": { "type": "boolean" }, "eventTypes": {}, "id": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "endpoint": { "id": "string", "orgId": "string", "url": "string", "description": "string", "eventTypes": [ "string" ], "secretPrefix": "string", "enabled": true, "disabledAt": "2026-01-31T12:00:00Z", "disabledReason": "manual", "consecutiveFailures": 0, "lastSuccessAt": "2026-01-31T12:00:00Z", "lastFailureAt": "2026-01-31T12:00:00Z", "createdByUserId": "string", "createdAt": "2026-01-31T12:00:00Z", "updatedAt": "2026-01-31T12:00:00Z" } }, "schema": { "properties": { "endpoint": { "properties": { "consecutiveFailures": { "type": "integer" }, "createdAt": { "description": "When the record was created (ISO 8601).", "format": "date-time", "type": "string" }, "createdByUserId": { "type": "string" }, "description": { "description": "Free-text description.", "type": "string" }, "disabledAt": { "format": "date-time", "type": [ "string", "null" ] }, "disabledReason": { "description": "Why the endpoint is disabled: by a user, or automatically after repeated delivery failures.", "enum": [ "manual", "failing" ], "type": [ "string", "null" ] }, "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" }, "eventTypes": { "description": "Subscribed event names; empty means every event.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Endpoint id.", "type": "string" }, "lastFailureAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastSuccessAt": { "format": "date-time", "type": [ "string", "null" ] }, "orgId": { "description": "Organization id.", "type": "string" }, "secretPrefix": { "description": "First characters of the signing secret (12 for a generated whsec_ secret, 4 for your own), to tell secrets apart.", "type": "string" }, "updatedAt": { "description": "When the record was last modified (ISO 8601).", "format": "date-time", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "id", "orgId", "url", "description", "eventTypes", "secretPrefix", "enabled", "disabledAt", "disabledReason", "consecutiveFailures", "lastSuccessAt", "lastFailureAt", "createdByUserId", "createdAt", "updatedAt" ], "type": "object" } }, "required": [ "endpoint" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"webhooks:write\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"webhooks:write\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "webhooks:write", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Update a webhook endpoint", "tags": [ "Webhooks" ], "x-modifies-data": true, "x-required-scope": "webhooks:write" } }, "/api/escritos/config": { "get": { "description": "Read organization filing configuration\n\nAuthentication: developer API key with `documents:read` scope.", "operationId": "escritos-config", "responses": { "200": { "content": { "application/json": { "example": { "version": 0, "global": { "liquidador": "string", "liquidadorRut": "string", "liquidadorDomicilio": "string", "liquidadorCorreo": "string", "firmaModo": "string", "abogado": "string", "abogadoRut": "string", "frasesTribunal": "string", "formulaCierre": "string", "otrosiesFijos": [ "string" ], "criteriosGenerales": "string" }, "tipos": [ { "tipo": "string", "label": "string", "labelEn": "string", "publicationType": "string", "draftKind": "string", "sumaPorDefecto": "string", "enabled": true, "autoDraft": true, "criterios": "string", "otrosiesFijos": [ "string" ], "preguntarAntes": true, "sumaEstandar": "string" } ], "plantillas": [ { "id": "string", "nombre": "string", "publicationType": "string", "canal": "auto", "instruccion": "string", "texto": "string", "requiereIA": true, "preguntas": [ { "clave": "string", "pregunta": "string" } ] } ], "variables": [ { "clave": "string", "pregunta": "string" } ], "organizationId": "string", "organizationName": "string", "canEdit": true }, "schema": { "properties": { "canEdit": { "description": "Whether the API key's acting user may edit it.", "type": "boolean" }, "global": { "properties": { "abogado": { "type": "string" }, "abogadoRut": { "type": "string" }, "criteriosGenerales": { "type": "string" }, "firmaModo": { "description": "Who signs: liquidador, abogado, or empty when undecided.", "type": "string" }, "formulaCierre": { "type": "string" }, "frasesTribunal": { "type": "string" }, "liquidador": { "type": "string" }, "liquidadorCorreo": { "type": "string" }, "liquidadorDomicilio": { "type": "string" }, "liquidadorRut": { "type": "string" }, "otrosiesFijos": { "description": "Otrosíes added to every escrito.", "items": { "type": "string" }, "type": "array" } }, "required": [ "liquidador", "liquidadorRut", "liquidadorDomicilio", "liquidadorCorreo", "firmaModo", "abogado", "abogadoRut", "frasesTribunal", "formulaCierre", "otrosiesFijos", "criteriosGenerales" ], "type": "object" }, "organizationId": { "type": "string" }, "organizationName": { "description": "Organization name.", "type": "string" }, "plantillas": { "description": "The organization's own escrito templates.", "items": { "properties": { "canal": { "enum": [ "auto", "bc", "pjud" ], "type": "string" }, "id": { "description": "Unique identifier.", "type": "string" }, "instruccion": { "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "preguntas": { "items": { "properties": { "clave": { "type": "string" }, "pregunta": { "type": "string" } }, "required": [ "clave", "pregunta" ], "type": "object" }, "type": "array" }, "publicationType": { "description": "Boletín publication type; 130 (mero trámite) by default.", "type": "string" }, "requiereIA": { "type": "boolean" }, "texto": { "description": "Fixed text with {variable} slots.", "type": "string" } }, "required": [ "id", "nombre", "publicationType", "canal", "instruccion", "texto", "requiereIA", "preguntas" ], "type": "object" }, "type": "array" }, "tipos": { "description": "Every escrito tipo of the catalogue, with the organization's settings resolved.", "items": { "properties": { "autoDraft": { "description": "Nexulex may draft it without a person asking.", "type": "boolean" }, "criterios": { "description": "Extra drafting criteria.", "type": "string" }, "draftKind": { "type": "string" }, "enabled": { "description": "Whether the feature is turned on.", "type": "boolean" }, "label": { "description": "Human-readable label.", "type": "string" }, "labelEn": { "type": "string" }, "otrosiesFijos": { "items": { "type": "string" }, "type": "array" }, "preguntarAntes": { "description": "A person starts the draft; never auto-drafted.", "type": "boolean" }, "publicationType": { "description": "Boletín Concursal publication type.", "type": "string" }, "sumaEstandar": { "type": "string" }, "sumaPorDefecto": { "description": "Suma used when sumaEstandar is empty.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "tipo", "enabled", "autoDraft", "criterios", "otrosiesFijos", "preguntarAntes", "sumaEstandar" ], "type": "object" }, "type": "array" }, "variables": { "description": "Variables every plantilla can use.", "items": { "properties": { "clave": { "description": "Variable name usable as {clave} in a plantilla.", "type": "string" }, "pregunta": { "description": "Question asked when the value is unknown.", "type": "string" } }, "required": [ "clave", "pregunta" ], "type": "object" }, "type": "array" }, "version": { "description": "Config version (last update, Unix milliseconds); a PUT must send the version it edited.", "type": "integer" } }, "required": [ "version", "global", "tipos", "plantillas", "variables", "organizationId", "organizationName", "canEdit" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"documents:read\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"documents:read\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "documents:read", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Read organization filing configuration", "tags": [ "Expedientes and activity" ], "x-required-scope": "documents:read" } }, "/api/public/organization-branding": { "get": { "description": "Get public organization branding\n\nAuthentication: none.", "operationId": "public-organization-branding", "responses": { "200": { "content": { "application/json": { "example": { "branding": { "displayName": "string", "logoUrl": "string", "primaryColor": "string", "accentColor": "string" } }, "schema": { "properties": { "branding": { "description": "Null when the host is not a verified, white-labeled domain.", "properties": { "accentColor": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "logoUrl": { "description": "Logo URL or data: URI.", "type": "string" }, "primaryColor": { "type": "string" } }, "required": [ "displayName", "logoUrl", "primaryColor", "accentColor" ], "type": [ "object", "null" ] } }, "required": [ "branding" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [], "summary": "Get public organization branding", "tags": [ "Reference data" ] } }, "/api/public/organization-favicon": { "get": { "description": "Get a public organization favicon\n\nAuthentication: none.", "operationId": "public-organization-favicon", "responses": { "200": { "description": "Success (file)" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [], "summary": "Get a public organization favicon", "tags": [ "Reference data" ] } }, "/api/public/resolve-domain": { "get": { "description": "Resolve a public organization domain\n\nAuthentication: none.", "operationId": "public-resolve-domain", "responses": { "200": { "content": { "application/json": { "example": { "verified": true, "orgId": "string" }, "schema": { "properties": { "orgId": { "description": "Organization of the domain; only when verified.", "type": "string" }, "verified": { "description": "Whether the request host is a verified custom domain.", "type": "boolean" } }, "required": [ "verified" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [], "summary": "Resolve a public organization domain", "tags": [ "Reference data" ] } }, "/api/ruts/search": { "post": { "description": "Search RUT records\n\nAuthentication: developer API key. Search the loaded voter-roll records. At least one of rut, nombre or direccion is required.", "operationId": "ruts-search", "requestBody": { "content": { "application/json": { "example": {}, "schema": { "properties": { "direccion": { "type": "string" }, "limit": { "type": "number" }, "nombre": { "type": "string" }, "rut": { "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "count": 0, "limit": 0, "items": [ { "rut": "string", "nombre": "string", "sexo": "string", "domicilioElectoral": "string", "circunscripcion": "string", "mesa": "string", "emails": [ "string" ], "phones": [ "string" ], "source": "string", "cacheState": "string", "lastSyncedAt": "2026-01-31T12:00:00Z" } ] }, "schema": { "properties": { "count": { "description": "Items returned.", "type": "integer" }, "items": { "description": "The records returned.", "items": { "properties": { "cacheState": { "description": "Always local-only.", "type": "string" }, "circunscripcion": { "type": "string" }, "domicilioElectoral": { "type": "string" }, "emails": { "items": { "type": "string" }, "type": "array" }, "lastSyncedAt": { "format": "date-time", "type": "string" }, "mesa": { "description": "Voting table number and letter.", "type": "string" }, "nombre": { "description": "Display name.", "type": "string" }, "phones": { "items": { "type": "string" }, "type": "array" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": "string" }, "sexo": { "description": "varon, mujer, otros, or empty when unknown.", "type": "string" }, "source": { "description": "Always local.", "type": "string" } }, "required": [ "rut", "nombre", "sexo", "domicilioElectoral", "circunscripcion" ], "type": "object" }, "type": "array" }, "limit": { "description": "Limit applied.", "type": "integer" } }, "required": [ "count", "limit", "items" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search RUT records", "tags": [ "RUTs" ], "x-modifies-data": true } }, "/api/storage/files/download": { "get": { "description": "Download a file from a signed storage URL\n\nAuthentication: signed URL. Provide `path`, `expires`, and `sig`; the URL expires at the supplied Unix timestamp.", "operationId": "storage-files-download", "parameters": [ { "description": "Signed storage path.", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Expiry as a Unix timestamp.", "in": "query", "name": "expires", "required": true, "schema": { "type": "number" } }, { "description": "HMAC signature for the path and expiry.", "in": "query", "name": "sig", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success (file)" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [], "summary": "Download a file from a signed storage URL", "tags": [ "Documents and Drive" ] } }, "/api/v1/causas/consulta": { "get": { "description": "Consulta única de una causa\n\nAuthentication: developer API key with `causas:lookup` scope. Plain alias of causa-lookup/lookup-causa: one live lookup of a public PJUD causa, every cuaderno, no files, not tracked. Billed per consulta. Scope `causas:lookup`.", "operationId": "v1-causas-consulta", "parameters": [ { "description": "CIVIL, LABORAL, COBRANZA, PENAL, APELACIONES or SUPREMA.", "in": "query", "name": "competencia", "required": true, "schema": { "type": "string" } }, { "description": "Rol/RIT as PJUD prints it, e.g. C-1234-2024.", "in": "query", "name": "rol", "required": true, "schema": { "type": "string" } }, { "description": "tribunalId from get-ojv-catalogs (not for APELACIONES/SUPREMA).", "in": "query", "name": "tribunal", "required": false, "schema": { "type": "number" } }, { "description": "corteId, for APELACIONES.", "in": "query", "name": "corte", "required": false, "schema": { "type": "number" } }, { "description": "Tipo/libro when the rol does not carry it (PENAL, APELACIONES).", "in": "query", "name": "libro", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "queueable": true, "data": { "lookupId": "string", "fetchedAt": "2026-01-31T12:00:00Z", "cached": true, "causa": { "basicInfo": { "competence": "string", "rol": "string", "caratulado": "string", "textoDemandas": [ { "index": 0, "doc": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string" } ], "estadosProcesal": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "fechaIng": "2026-01-31T12:00:00Z", "certEnvioId": "string", "ebookId": "string", "etapas": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "anexos": [ { "index": 0, "doc": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "tramite": "string", "codigo": "string", "cantidad": 0, "tipoDoc": "string", "rut": "string", "nombre": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string" } ], "estadosAdmin": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "tipoProcedimiento": "string", "tomos": [ { "tomo": "string", "fojaInicio": "string", "fojaFin": "string", "principal": true } ], "docsCausa": [ { "index": 0, "doc": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string" } ], "obs": { "raw": "string", "relatorAsignado": "string" }, "relator": "string", "incompetencias": [ { "rol": "string", "tribunalId": 0 } ], "ubicaciones": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "ruc": "string", "tribunalOrigenId": 0, "juezAsignado": "string", "tituloEjecutivo": "string", "estadosDeuda": [ { "prestacion": "string", "fechaPrestacion": "2026-01-31T12:00:00Z", "fechaActualizar": "2026-01-31T12:00:00Z", "saldoDeuda": 0, "fechaLiq": "2026-01-31T12:00:00Z", "porcentajeReajuste": 0, "porcentajeInteres": 0 } ], "formaDeInicio": "string", "materias": [ { "codigo": "string", "glosa": "string", "estado": "string", "fechaTermino": "2026-01-31T12:00:00Z" } ], "docErrors": [ "string" ] }, "litigantes": [ { "participante": "string", "rut": "string", "persona": "string", "nombre": "string", "abogadoDefensor": true, "estado": true } ], "exhortos": [ { "rolOrigen": "string", "tipoExhorto": "string", "documentosExhortos": [ { "index": 0, "doc": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "pieza": "string" } ], "fechaOrdenaExhorto": "2026-01-31T12:00:00Z", "fechaIngresaExhorto": "2026-01-31T12:00:00Z", "rolDestino": "string", "tribunalDestino": 0, "tribunalDestinoName": "string", "estadoExhorto": "string", "tribunalOrigen": "string", "docErrors": [ "string" ] } ], "remisiones": [ { "corteId": 0, "tribunalId": 0, "competence": "string", "rol": "string", "texto": "string", "tipo": "string", "fecha": "2026-01-31T12:00:00Z" } ], "notificacionesReceptor": [ { "index": 0, "cuaderno": "string", "datosDelRetiro": "string", "fechaRetiro": "2026-01-31T12:00:00Z", "estado": "string" } ], "plazos": [ { "tipoPlazo": "string", "ambitoAfectado": "string", "fechaInicio": "2026-01-31T12:00:00Z", "fechaTermino": "2026-01-31T12:00:00Z", "duracion": "string", "estado": "string", "tramite": "string", "fechaSuspencion": "2026-01-31T12:00:00Z", "fechaReactivacion": "2026-01-31T12:00:00Z" } ], "liquidaciones": [ { "fechaTramite": "2026-01-31T12:00:00Z", "cuadernoLiq": "string", "estado": "string", "monto": 0, "nombre": "string", "rut": "string" } ], "cuadernosData": [ { "historias": [ { "order": 0, "folio": "string", "nulo": true, "reposicion": true, "mismoFolio": 0, "doc": "string", "especial": true, "sala": "string", "certEnvioId": "string", "anexoType": "string", "anexos": [ { "index": 0, "doc": null, "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "tramite": "string", "codigo": "string", "cantidad": 0, "tipoDoc": "string", "rut": "string", "nombre": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string" } ], "etapa": "string", "estado": "string", "tramite": "string", "descTramite": "string", "fechaTramite": "2026-01-31T12:00:00Z", "segundaFechaTramite": "2026-01-31T12:00:00Z", "fechaRecepcion": "2026-01-31T12:00:00Z", "foja": "string", "georref": { "latitud": 0, "longitud": 0, "lat": 0, "lng": 0, "corrector": 0 }, "docsDescTramite": [ { "doc": null, "fecha": "string", "referencia": "string" } ], "conAudios": true, "rut": "string", "nombre": "string", "monto": 0, "cuadernoLiq": "string", "anexosToken": "string", "docErrors": [ "string" ] } ], "notificaciones": [ { "index": 0, "rol": "string", "estadoNotif": "string", "tipoNotif": "string", "fechaTramite": "2026-01-31T12:00:00Z", "fechaAudiencia": "2026-01-31T12:00:00Z", "tipoPart": "string", "nombre": "string", "tramite": "string", "obsFallida": "string", "ruc": "string", "enteNotificador": "string", "notificationDetail": [ { "idx": 0, "codigo": "string", "fecha": "2026-01-31T12:00:00Z", "tipo": "string", "observación": "string" } ], "identityKey": "string" } ], "escritosPorResolver": [ { "doc": "string", "anexos": [ { "index": 0, "doc": null, "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "tramite": "string", "codigo": "string", "cantidad": 0, "tipoDoc": "string", "rut": "string", "nombre": "string", "docFisico": "string", "doctoFisico": "string", "estadoFirma": "string", "tipoLit": "string" } ], "fechaIngreso": "2026-01-31T12:00:00Z", "tipo": "string", "solicitante": "string", "referencia": "string", "indexPorFecha": 0, "docErrors": [ "string" ] } ], "cuaderno": { "index": 0, "order": 0, "name": "string", "estadosProcesal": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "etapas": [ { "changedAt": "2026-01-31T12:00:00Z", "value": "string", "counter": 0 } ], "tipoProcedimiento": "string" }, "audios": [ { "numero": 0, "audio": "string", "fecha": "2026-01-31T12:00:00Z", "referencia": "string", "docErrors": [ "string" ] } ], "diligencias": [ { "index": 0, "docIda": "string", "docVta": "string", "estado": "string", "rit": "string", "ruc": "string", "tipoDiligencia": "string", "referencia": "string", "destinatario": "string", "responsable": "string", "fecha": "2026-01-31T12:00:00Z", "docErrors": [ "string" ], "identityKey": "string" } ], "relaciones": [ { "index": 0, "nombre": "string", "delito": "string", "estado": "string", "fechaCambioEstado": "2026-01-31T12:00:00Z", "identityKey": "string" } ] } ] }, "documents": [ { "documentRef": "string", "kind": "string", "cuaderno": "string", "folio": "string", "fecha": "2026-01-31T12:00:00Z", "descripcion": "string" } ], "follow": { "competence": "string", "corteId": 0, "tribunalId": 0, "libro": "string", "val": "string", "year": "string" } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "cached": { "type": "boolean" }, "causa": { "properties": { "basicInfo": { "properties": { "anexos": { "description": "Attachments.", "items": { "properties": { "cantidad": { "type": [ "number", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": [ "string", "null" ] }, "docFisico": { "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "estadoFirma": { "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "certEnvioId": { "description": "PJUD certificate-of-filing id.", "type": [ "string", "null" ] }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "docErrors": { "items": { "type": "string" }, "type": "array" }, "docsCausa": { "items": { "properties": { "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "ebookId": { "type": [ "string", "null" ] }, "estadosAdmin": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "estadosDeuda": { "items": { "properties": { "fechaActualizar": { "description": "Date the amount was last updated (ISO 8601).", "format": "date-time", "type": "string" }, "fechaLiq": { "description": "Settlement date (ISO 8601).", "format": "date-time", "type": "string" }, "fechaPrestacion": { "description": "Date of the claimed benefit (ISO 8601).", "format": "date-time", "type": "string" }, "porcentajeInteres": { "description": "Interest percentage.", "type": "number" }, "porcentajeReajuste": { "description": "Inflation adjustment percentage.", "type": "number" }, "prestacion": { "description": "Claimed benefit or payment.", "type": "string" }, "saldoDeuda": { "description": "Outstanding debt balance in Chilean pesos.", "type": "number" } }, "required": [ "prestacion", "fechaPrestacion", "fechaActualizar", "saldoDeuda", "fechaLiq", "porcentajeReajuste", "porcentajeInteres" ], "type": "object" }, "type": "array" }, "estadosProcesal": { "description": "Procedural statuses.", "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "etapas": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "fechaIng": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": "string" }, "formaDeInicio": { "type": [ "string", "null" ] }, "incompetencias": { "items": { "properties": { "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" } }, "required": [ "rol", "tribunalId" ], "type": "object" }, "type": "array" }, "juezAsignado": { "type": [ "string", "null" ] }, "materias": { "items": { "properties": { "codigo": { "description": "Short code.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaTermino": { "description": "End date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "glosa": { "description": "Description as PJUD words it.", "type": "string" } }, "required": [ "codigo" ], "type": "object" }, "type": "array" }, "obs": { "description": "Suprema only.", "properties": { "raw": { "description": "Observations block text.", "type": "string" }, "relatorAsignado": { "type": "string" } }, "required": [ "raw" ], "type": "object" }, "relator": { "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": [ "string", "null" ] }, "textoDemandas": { "items": { "properties": { "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "tipoProcedimiento": { "description": "Procedure type.", "type": "string" }, "tituloEjecutivo": { "type": [ "string", "null" ] }, "tomos": { "description": "Suprema only: the expediente's volumes.", "items": { "properties": { "fojaFin": { "type": "string" }, "fojaInicio": { "type": "string" }, "principal": { "type": "boolean" }, "tomo": { "type": "string" } }, "required": [ "tomo", "fojaInicio", "fojaFin", "principal" ], "type": "object" }, "type": "array" }, "tribunalOrigenId": { "type": [ "integer", "null" ] }, "ubicaciones": { "items": { "properties": { "changedAt": { "description": "When it changed (ISO 8601).", "format": "date-time", "type": "string" }, "counter": { "description": "Running counter.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" } }, "required": [ "competence", "rol", "caratulado", "fechaIng" ], "type": "object" }, "cuadernosData": { "items": { "properties": { "audios": { "items": { "properties": { "audio": { "type": "string" }, "docErrors": { "description": "Documents that failed to download.", "items": { "type": "string" }, "type": "array" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "numero": { "description": "Number.", "type": "integer" }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "numero", "audio" ], "type": "object" }, "type": "array" }, "cuaderno": { "description": "Cuaderno (case-file notebook).", "properties": { "estadosProcesal": { "description": "Procedural statuses.", "items": { "properties": { "changedAt": { "description": "When this value was first seen.", "format": "date-time", "type": "string" }, "counter": { "description": "How many times this value has been seen in a row.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "etapas": { "items": { "properties": { "changedAt": { "description": "When this value was first seen.", "format": "date-time", "type": "string" }, "counter": { "description": "How many times this value has been seen in a row.", "type": "integer" }, "value": { "description": "Value.", "type": "string" } }, "required": [ "changedAt", "value", "counter" ], "type": "object" }, "type": "array" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "name": { "description": "Display name.", "type": "string" }, "order": { "description": "Sort position.", "type": "integer" }, "tipoProcedimiento": { "description": "Procedure type.", "type": [ "string", "null" ] } }, "required": [ "index", "order", "name" ], "type": "object" }, "diligencias": { "items": { "properties": { "destinatario": { "description": "Recipient.", "type": [ "string", "null" ] }, "docErrors": { "description": "Documents that failed to download.", "items": { "type": "string" }, "type": "array" }, "docIda": { "description": "Outgoing document of the exhorto.", "type": [ "string", "null" ] }, "docVta": { "description": "Returned document of the exhorto.", "type": [ "string", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "identityKey": { "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "responsable": { "description": "Person responsible.", "type": [ "string", "null" ] }, "rit": { "description": "Causa RIT, for courts that number by RIT.", "type": "string" }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": "string" }, "tipoDiligencia": { "description": "Type of court proceeding.", "type": "string" } }, "required": [ "index", "estado", "rit", "ruc", "tipoDiligencia" ], "type": "object" }, "type": "array" }, "escritosPorResolver": { "items": { "properties": { "anexos": { "description": "Anexos; doc is always null in lookups (download through documents).", "items": { "properties": { "cantidad": { "type": [ "number", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "null" }, "docFisico": { "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "estadoFirma": { "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": [ "string", "null" ] }, "docErrors": { "description": "Always omitted from lookup results.", "items": { "type": "string" }, "type": "array" }, "fechaIngreso": { "description": "Date the causa was filed (ISO 8601).", "format": "date-time", "type": "string" }, "indexPorFecha": { "description": "Position among the entries of the same date.", "type": "integer" }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "solicitante": { "description": "Who made the request.", "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "fechaIngreso", "tipo", "solicitante", "indexPorFecha" ], "type": "object" }, "type": "array" }, "historias": { "items": { "properties": { "anexoType": { "description": "Attachment type.", "type": [ "string", "null" ] }, "anexos": { "description": "Anexos; doc is always null in lookups (download through documents).", "items": { "properties": { "cantidad": { "type": [ "number", "null" ] }, "codigo": { "description": "Short code.", "type": [ "string", "null" ] }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "null" }, "docFisico": { "type": [ "string", "null" ] }, "doctoFisico": { "type": [ "string", "null" ] }, "estadoFirma": { "type": [ "string", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "tipoDoc": { "type": [ "string", "null" ] }, "tipoLit": { "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "anexosToken": { "type": [ "string", "null" ] }, "certEnvioId": { "description": "PJUD certificate-of-filing id.", "type": [ "string", "null" ] }, "conAudios": { "description": "Whether hearing audio is attached.", "type": [ "boolean", "null" ] }, "cuadernoLiq": { "description": "Liquidation notebook the entry belongs to.", "type": [ "string", "null" ] }, "descTramite": { "description": "Description of the procedural step.", "type": "string" }, "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": [ "string", "null" ] }, "docErrors": { "description": "Always omitted from lookup results.", "items": { "type": "string" }, "type": "array" }, "docsDescTramite": { "description": "Documents linked from the trámite description.", "items": { "properties": { "doc": { "description": "Always null in a lookup (PJUD tokens are never returned).", "type": "null" }, "fecha": { "description": "Date (ISO 8601).", "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "doc", "fecha", "referencia" ], "type": "object" }, "type": "array" }, "especial": { "description": "Whether PJUD flags the entry as special.", "type": "boolean" }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "etapa": { "description": "Procedural stage.", "type": "string" }, "fechaRecepcion": { "description": "Date received (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaTramite": { "description": "Date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "foja": { "description": "Foja (page number in the court file).", "type": [ "string", "null" ] }, "folio": { "description": "Folio number in the court file.", "type": "string" }, "georref": { "description": "Georeference PJUD attaches to the entry.", "properties": { "corrector": { "description": "Correction value, when PJUD sends one.", "type": "number" }, "lat": { "description": "Alias of latitud.", "type": "number" }, "latitud": { "description": "Latitude; kept as the portal's string if it is not numeric.", "type": "number" }, "lng": { "description": "Alias of longitud.", "type": "number" }, "longitud": { "description": "Longitude; kept as the portal's string if it is not numeric.", "type": "number" } }, "required": [ "latitud", "longitud", "lat", "lng" ], "type": "object" }, "mismoFolio": { "description": "Whether it shares the previous entry's folio.", "type": "integer" }, "monto": { "description": "Amount in Chilean pesos.", "type": [ "integer", "null" ] }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "nulo": { "description": "Whether PJUD marks the entry as void.", "type": "boolean" }, "order": { "description": "Sort position.", "type": [ "integer", "null" ] }, "reposicion": { "description": "Whether the entry is a motion for reconsideration.", "type": "boolean" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] }, "sala": { "description": "Court chamber (sala).", "type": [ "string", "null" ] }, "segundaFechaTramite": { "description": "Second date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "tramite": { "description": "Procedural step.", "type": "string" } }, "required": [ "folio", "nulo", "reposicion", "mismoFolio", "especial", "etapa", "tramite", "descTramite" ], "type": "object" }, "type": "array" }, "notificaciones": { "items": { "properties": { "enteNotificador": { "description": "Who served the notification.", "type": [ "string", "null" ] }, "estadoNotif": { "description": "Notification status.", "type": "string" }, "fechaAudiencia": { "description": "Hearing date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaTramite": { "description": "Date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "identityKey": { "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "notificationDetail": { "description": "Notification detail.", "items": { "properties": { "codigo": { "description": "Short code.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "idx": { "description": "Row position.", "type": "integer" }, "observación": { "type": "string" }, "tipo": { "description": "Record type.", "type": "string" } }, "required": [ "idx", "codigo", "fecha", "tipo", "observación" ], "type": "object" }, "type": "array" }, "obsFallida": { "description": "Note on why the notification failed.", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": [ "string", "null" ] }, "ruc": { "description": "RUC (unique case number assigned by the prosecutor's office).", "type": [ "string", "null" ] }, "tipoNotif": { "description": "Notification type.", "type": [ "string", "null" ] }, "tipoPart": { "description": "Party role in the causa.", "type": "string" }, "tramite": { "description": "Procedural step.", "type": "string" } }, "required": [ "index", "estadoNotif", "tipoPart", "tramite" ], "type": "object" }, "type": "array" }, "relaciones": { "items": { "properties": { "delito": { "description": "Offense (penal causas).", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaCambioEstado": { "description": "Date of the last status change (ISO 8601).", "format": "date-time", "type": "string" }, "identityKey": { "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "nombre": { "description": "Display name.", "type": "string" } }, "required": [ "index", "nombre", "delito", "estado", "fechaCambioEstado" ], "type": "object" }, "type": "array" } }, "required": [ "historias", "notificaciones", "escritosPorResolver", "cuaderno", "audios", "diligencias", "relaciones" ], "type": "object" }, "type": "array" }, "exhortos": { "items": { "properties": { "docErrors": { "items": { "type": "string" }, "type": "array" }, "documentosExhortos": { "description": "Documents of the exhorto.", "items": { "properties": { "doc": { "description": "Document reference; fetch it with get-tracked-case-document-url.", "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "index": { "description": "Position in the list (0-based).", "type": "integer" }, "pieza": { "type": [ "string", "null" ] }, "referencia": { "description": "Reference text.", "type": [ "string", "null" ] } }, "required": [ "index", "doc" ], "type": "object" }, "type": "array" }, "estadoExhorto": { "description": "Exhorto status.", "type": "string" }, "fechaIngresaExhorto": { "description": "Date the exhorto was filed (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaOrdenaExhorto": { "description": "Date the exhorto was ordered (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "rolDestino": { "description": "Rol at the receiving court.", "type": "string" }, "rolOrigen": { "description": "Rol at the originating court.", "type": [ "string", "null" ] }, "tipoExhorto": { "description": "Exhorto (letter rogatory) type.", "type": [ "string", "null" ] }, "tribunalDestino": { "description": "Court the case went to.", "type": "integer" }, "tribunalDestinoName": { "type": "string" }, "tribunalOrigen": { "description": "Court the case came from.", "type": "string" } }, "required": [ "rolDestino", "tribunalDestino", "estadoExhorto", "tribunalOrigen" ], "type": "object" }, "type": "array" }, "liquidaciones": { "items": { "properties": { "cuadernoLiq": { "description": "Liquidation notebook the entry belongs to.", "type": [ "string", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": [ "string", "null" ] }, "fechaTramite": { "description": "Date of the procedural step (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "monto": { "description": "Amount in Chilean pesos.", "type": [ "number", "null" ] }, "nombre": { "description": "Display name.", "type": [ "string", "null" ] }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "litigantes": { "items": { "properties": { "abogadoDefensor": { "description": "Defense attorney.", "type": [ "boolean", "null" ] }, "estado": { "description": "Status as PJUD reports it.", "type": [ "boolean", "null" ] }, "nombre": { "description": "Display name.", "type": "string" }, "participante": { "description": "Parties to the causa.", "type": [ "string", "null" ] }, "persona": { "description": "Party name.", "type": "string" }, "rut": { "description": "Chilean RUT (tax id) with check digit.", "type": [ "string", "null" ] } }, "required": [ "persona", "nombre" ], "type": "object" }, "type": "array" }, "notificacionesReceptor": { "items": { "properties": { "cuaderno": { "description": "Cuaderno (case-file notebook).", "type": "string" }, "datosDelRetiro": { "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaRetiro": { "format": "date-time", "type": "string" }, "index": { "description": "Position in the list (0-based).", "type": "integer" } }, "required": [ "index", "cuaderno", "datosDelRetiro", "fechaRetiro", "estado" ], "type": "object" }, "type": "array" }, "plazos": { "items": { "properties": { "ambitoAfectado": { "description": "Scope the deadline affects.", "type": "string" }, "duracion": { "description": "Duration.", "type": "string" }, "estado": { "description": "Status as PJUD reports it.", "type": "string" }, "fechaInicio": { "description": "Start date (ISO 8601).", "format": "date-time", "type": "string" }, "fechaReactivacion": { "description": "Date reactivated (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaSuspencion": { "description": "Date suspended (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "fechaTermino": { "description": "End date (ISO 8601).", "format": "date-time", "type": "string" }, "tipoPlazo": { "description": "Deadline type.", "type": "string" }, "tramite": { "description": "Procedural step.", "type": "string" } }, "required": [ "tipoPlazo", "ambitoAfectado", "fechaInicio", "fechaTermino", "duracion", "estado", "tramite" ], "type": "object" }, "type": "array" }, "remisiones": { "items": { "properties": { "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": [ "integer", "null" ] }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "texto": { "type": [ "string", "null" ] }, "tipo": { "description": "Record type.", "type": [ "string", "null" ] }, "tribunalId": { "description": "PJUD court id.", "type": [ "integer", "null" ] } }, "required": [ "competence", "rol" ], "type": "object" }, "type": "array" } }, "required": [ "basicInfo", "litigantes", "exhortos", "remisiones", "notificacionesReceptor", "plazos", "liquidaciones", "cuadernosData" ], "type": "object" }, "documents": { "description": "Documents.", "items": { "properties": { "cuaderno": { "description": "Cuaderno (case-file notebook).", "type": "string" }, "descripcion": { "type": "string" }, "documentRef": { "type": "string" }, "fecha": { "description": "Date (ISO 8601).", "format": "date-time", "type": [ "string", "null" ] }, "folio": { "description": "Folio number in the court file.", "type": "string" }, "kind": { "description": "Record subtype.", "type": "string" } }, "required": [ "documentRef", "kind" ], "type": "object" }, "type": "array" }, "fetchedAt": { "format": "date-time", "type": "string" }, "follow": { "properties": { "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": "integer" }, "libro": { "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" }, "val": { "type": "string" }, "year": { "type": "string" } }, "required": [ "competence", "corteId", "tribunalId", "libro", "val", "year" ], "type": "object" }, "lookupId": { "type": "string" } }, "required": [ "lookupId", "fetchedAt", "cached", "causa", "documents", "follow" ], "type": [ "object", "null" ] }, "queueable": { "type": "boolean" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:lookup\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:lookup\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:lookup", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Consulta única de una causa", "tags": [ "PJUD causas" ], "x-required-scope": "causas:lookup" } }, "/api/v1/causas/consulta/documento": { "post": { "description": "Descargar un documento de una consulta\n\nAuthentication: developer API key with `causas:lookup` scope. Downloads one document of a consulta and returns a signed URL valid for one hour. Billed per document.", "operationId": "v1-causas-consulta-documento", "requestBody": { "content": { "application/json": { "example": { "documentRef": "\u003cdocumentRef\u003e", "lookupId": "\u003clookupId\u003e" }, "schema": { "properties": { "documentRef": { "type": "string" }, "lookupId": { "type": "string" } }, "required": [ "lookupId", "documentRef" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "url": "string", "expiresAt": "2026-01-31T12:00:00Z", "fileName": "string" } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "expiresAt": { "format": "date-time", "type": "string" }, "fileName": { "description": "Original file name.", "type": "string" }, "url": { "description": "Absolute URL.", "type": "string" } }, "required": [ "url", "expiresAt", "fileName" ], "type": [ "object", "null" ] } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:lookup\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:lookup\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:lookup", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Descargar un documento de una consulta", "tags": [ "PJUD causas" ], "x-required-scope": "causas:lookup" } }, "/api/v1/causas/consulta/{lookupId}": { "get": { "description": "Reabrir una consulta\n\nAuthentication: developer API key with `causas:lookup` scope. A consulta of the last 7 days, in full. Free.", "operationId": "v1-causas-consulta-lookupId", "requestBody": { "content": { "application/json": { "example": { "lookupId": "\u003clookupId\u003e" }, "schema": { "properties": { "lookupId": { "type": "string" } }, "required": [ "lookupId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "lookupId": "string", "competence": "string", "rol": "string", "caratulado": "string", "tribunal": "string", "source": "string", "fetchedAt": "string" } ], "lookupId": "string", "fetchedAt": "2026-01-31T12:00:00Z", "cached": true, "causa": "string", "documents": "string", "follow": { "competence": "string", "corteId": 0, "tribunalId": 0, "libro": "string", "val": "string", "year": "string" }, "prices": { "consulta": 0, "documento": 0 } } }, "schema": { "properties": { "data": { "description": "The action's result.", "properties": { "cached": { "type": "boolean" }, "causa": { "type": "string" }, "documents": { "description": "Documents.", "type": "string" }, "fetchedAt": { "format": "date-time", "type": "string" }, "follow": { "properties": { "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "corteId": { "description": "PJUD court of appeals id.", "type": "integer" }, "libro": { "type": "string" }, "tribunalId": { "description": "PJUD court id.", "type": "integer" }, "val": { "type": "string" }, "year": { "type": "string" } }, "required": [ "competence", "corteId", "tribunalId", "libro", "val", "year" ], "type": "object" }, "items": { "description": "The records returned.", "items": { "properties": { "caratulado": { "description": "Causa caption (the parties as PJUD lists them).", "type": "string" }, "competence": { "description": "PJUD competencia: civil, laboral, cobranza, familia, penal, corte suprema or corte de apelaciones.", "type": "string" }, "fetchedAt": { "type": "string" }, "lookupId": { "type": "string" }, "rol": { "description": "Causa rol (e.g. C-1234-2024).", "type": "string" }, "source": { "description": "Where the record came from.", "type": "string" }, "tribunal": { "description": "Court name.", "type": "string" } }, "required": [ "lookupId", "competence", "rol", "caratulado", "tribunal", "source", "fetchedAt" ], "type": "object" }, "type": "array" }, "lookupId": { "type": "string" }, "prices": { "description": "Only on the list (no lookupId).", "properties": { "consulta": { "description": "Price of the next lookup in CLP, IVA included; 0 inside the monthly allowance or when exempt.", "type": "integer" }, "documento": { "description": "Price of the next document download in CLP, IVA included.", "type": "integer" } }, "required": [ "consulta", "documento" ], "type": "object" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Indica el procedimiento.", "errorCode": "INVALID_REQUEST", "message": "The request is invalid: a required field is missing or a value is not accepted.", "messageEs": "Indica el procedimiento.", "status": 400 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Invalid request" }, "401": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "Unauthorized", "errorCode": "API_KEY_INVALID", "message": "This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.", "messageEs": "Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.", "status": 401 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Authentication required" }, "402": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "payment_method_required", "errorCode": "PAYMENT_METHOD_REQUIRED", "message": "The organization used up its free API quota: add a payment method under Billing to keep calling the API.", "messageEs": "La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.", "status": 402 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "status" ], "type": "object" } } }, "description": "Payment required" }, "403": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "insufficient_scope", "errorCode": "INSUFFICIENT_SCOPE", "message": "This API key lacks the \"causas:lookup\" scope this route needs. Add it to the key under Settings → API keys (or create a key that has it).", "messageEs": "Esta llave API no tiene el scope \"causas:lookup\" que requiere esta ruta. Agrégalo a la llave en Configuración → Llaves API (o crea una llave que lo tenga).", "requiredScope": "causas:lookup", "status": 403 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "requiredScope": { "type": "string" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "requiredScope", "status" ], "type": "object" } } }, "description": "Missing scope" }, "429": { "content": { "application/json": { "example": { "docs": "https://www.nexulex.com/docs/api#errors", "error": "rate_limited", "errorCode": "RATE_LIMITED", "message": "This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.", "messageEs": "Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.", "retryAfter": 12, "status": 429 }, "schema": { "properties": { "docs": { "type": "string" }, "error": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" }, "messageEs": { "type": "string" }, "retryAfter": { "type": "number" }, "status": { "type": "number" } }, "required": [ "docs", "error", "errorCode", "message", "messageEs", "retryAfter", "status" ], "type": "object" } } }, "description": "Rate limited" } }, "security": [ { "bearerAuth": [] } ], "summary": "Reabrir una consulta", "tags": [ "PJUD causas" ], "x-required-scope": "causas:lookup" } } }, "servers": [ { "url": "https://api.nexulex.com" } ], "tags": [ { "name": "PJUD causas" }, { "name": "Expedientes and activity" }, { "name": "Case law" }, { "name": "Tax and Customs Courts (TTA)" }, { "name": "Insolvency Bulletin" }, { "name": "Constitutional Court" }, { "name": "Public Procurement Court" }, { "name": "RUTs" }, { "name": "Liquidations" }, { "name": "Clients" }, { "name": "Tasks" }, { "name": "Time and billing" }, { "name": "Artificial intelligence" }, { "name": "Documents and Drive" }, { "name": "Workflows" }, { "name": "Communications" }, { "name": "Reports" }, { "name": "Integrations" }, { "name": "Webhooks" }, { "name": "Agenda" }, { "name": "Reference data" }, { "name": "Other product features" } ] }