{ "auth": { "bearer": [ { "key": "token", "type": "string", "value": "{{apiKey}}" } ], "type": "bearer" }, "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.", "name": "Nexulex API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "item": [ { "name": "Consulta única de una causa", "request": { "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`.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "causas", "consulta" ], "query": [ { "description": "CIVIL, LABORAL, COBRANZA, PENAL, APELACIONES or SUPREMA.", "disabled": false, "key": "competencia", "value": "" }, { "description": "Rol/RIT as PJUD prints it, e.g. C-1234-2024.", "disabled": false, "key": "rol", "value": "" }, { "description": "tribunalId from get-ojv-catalogs (not for APELACIONES/SUPREMA).", "disabled": true, "key": "tribunal", "value": "" }, { "description": "corteId, for APELACIONES.", "disabled": true, "key": "corte", "value": "" }, { "description": "Tipo/libro when the rol does not carry it (PENAL, APELACIONES).", "disabled": true, "key": "libro", "value": "" } ], "raw": "{{baseUrl}}/api/v1/causas/consulta?competencia=\u0026rol=" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"queueable\": true,\n \"data\": {\n \"lookupId\": \"string\",\n \"fetchedAt\": \"2026-01-31T12:00:00Z\",\n \"cached\": true,\n \"causa\": {\n \"basicInfo\": {\n \"competence\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"textoDemandas\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\"\n }\n ],\n \"estadosProcesal\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"fechaIng\": \"2026-01-31T12:00:00Z\",\n \"certEnvioId\": \"string\",\n \"ebookId\": \"string\",\n \"etapas\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"anexos\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\"\n }\n ],\n \"estadosAdmin\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"tipoProcedimiento\": \"string\",\n \"tomos\": [\n {\n \"tomo\": \"string\",\n \"fojaInicio\": \"string\",\n \"fojaFin\": \"string\",\n \"principal\": true\n }\n ],\n \"docsCausa\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\"\n }\n ],\n \"obs\": {\n \"raw\": \"string\",\n \"relatorAsignado\": \"string\"\n },\n \"relator\": \"string\",\n \"incompetencias\": [\n {\n \"rol\": \"string\",\n \"tribunalId\": 0\n }\n ],\n \"ubicaciones\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"ruc\": \"string\",\n \"tribunalOrigenId\": 0,\n \"juezAsignado\": \"string\",\n \"tituloEjecutivo\": \"string\",\n \"estadosDeuda\": [\n {\n \"prestacion\": \"string\",\n \"fechaPrestacion\": \"2026-01-31T12:00:00Z\",\n \"fechaActualizar\": \"2026-01-31T12:00:00Z\",\n \"saldoDeuda\": 0,\n \"fechaLiq\": \"2026-01-31T12:00:00Z\",\n \"porcentajeReajuste\": 0,\n \"porcentajeInteres\": 0\n }\n ],\n \"formaDeInicio\": \"string\",\n \"materias\": [\n {\n \"codigo\": \"string\",\n \"glosa\": \"string\",\n \"estado\": \"string\",\n \"fechaTermino\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"docErrors\": [\n \"string\"\n ]\n },\n \"litigantes\": [\n {\n \"participante\": \"string\",\n \"rut\": \"string\",\n \"persona\": \"string\",\n \"nombre\": \"string\",\n \"abogadoDefensor\": true,\n \"estado\": true\n }\n ],\n \"exhortos\": [\n {\n \"rolOrigen\": \"string\",\n \"tipoExhorto\": \"string\",\n \"documentosExhortos\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\"\n }\n ],\n \"fechaOrdenaExhorto\": \"2026-01-31T12:00:00Z\",\n \"fechaIngresaExhorto\": \"2026-01-31T12:00:00Z\",\n \"rolDestino\": \"string\",\n \"tribunalDestino\": 0,\n \"tribunalDestinoName\": \"string\",\n \"estadoExhorto\": \"string\",\n \"tribunalOrigen\": \"string\",\n \"docErrors\": [\n \"string\"\n ]\n }\n ],\n \"remisiones\": [\n {\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"competence\": \"string\",\n \"rol\": \"string\",\n \"texto\": \"string\",\n \"tipo\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"notificacionesReceptor\": [\n {\n \"index\": 0,\n \"cuaderno\": \"string\",\n \"datosDelRetiro\": \"string\",\n \"fechaRetiro\": \"2026-01-31T12:00:00Z\",\n \"estado\": \"string\"\n }\n ],\n \"plazos\": [\n {\n \"tipoPlazo\": \"string\",\n \"ambitoAfectado\": \"string\",\n \"fechaInicio\": \"2026-01-31T12:00:00Z\",\n \"fechaTermino\": \"2026-01-31T12:00:00Z\",\n \"duracion\": \"string\",\n \"estado\": \"string\",\n \"tramite\": \"string\",\n \"fechaSuspencion\": \"2026-01-31T12:00:00Z\",\n \"fechaReactivacion\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"liquidaciones\": [\n {\n \"fechaTramite\": \"2026-01-31T12:00:00Z\",\n \"cuadernoLiq\": \"string\",\n \"estado\": \"string\",\n \"monto\": 0,\n \"nombre\": \"string\",\n \"rut\": \"string\"\n }\n ],\n \"cuadernosData\": [\n {\n \"historias\": [\n {\n \"order\": 0,\n \"folio\": \"string\",\n \"nulo\": true,\n \"reposicion\": true,\n \"mismoFolio\": 0,\n \"doc\": \"string\",\n \"especial\": true,\n \"sala\": \"string\",\n \"certEnvioId\": \"string\",\n \"anexoType\": \"string\",\n \"anexos\": [\n {\n \"index\": 0,\n \"doc\": null,\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\"\n }\n ],\n \"etapa\": \"string\",\n \"estado\": \"string\",\n \"tramite\": \"string\",\n \"descTramite\": \"string\",\n \"fechaTramite\": \"2026-01-31T12:00:00Z\",\n \"segundaFechaTramite\": \"2026-01-31T12:00:00Z\",\n \"fechaRecepcion\": \"2026-01-31T12:00:00Z\",\n \"foja\": \"string\",\n \"georref\": {\n \"latitud\": 0,\n \"longitud\": 0,\n \"lat\": 0,\n \"lng\": 0,\n \"corrector\": 0\n },\n \"docsDescTramite\": [\n {\n \"doc\": null,\n \"fecha\": \"string\",\n \"referencia\": \"string\"\n }\n ],\n \"conAudios\": true,\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"monto\": 0,\n \"cuadernoLiq\": \"string\",\n \"anexosToken\": \"string\",\n \"docErrors\": [\n \"string\"\n ]\n }\n ],\n \"notificaciones\": [\n {\n \"index\": 0,\n \"rol\": \"string\",\n \"estadoNotif\": \"string\",\n \"tipoNotif\": \"string\",\n \"fechaTramite\": \"2026-01-31T12:00:00Z\",\n \"fechaAudiencia\": \"2026-01-31T12:00:00Z\",\n \"tipoPart\": \"string\",\n \"nombre\": \"string\",\n \"tramite\": \"string\",\n \"obsFallida\": \"string\",\n \"ruc\": \"string\",\n \"enteNotificador\": \"string\",\n \"notificationDetail\": [\n {\n \"idx\": 0,\n \"codigo\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"tipo\": \"string\",\n \"observación\": \"string\"\n }\n ],\n \"identityKey\": \"string\"\n }\n ],\n \"escritosPorResolver\": [\n {\n \"doc\": \"string\",\n \"anexos\": [\n {\n \"index\": 0,\n \"doc\": null,\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\"\n }\n ],\n \"fechaIngreso\": \"2026-01-31T12:00:00Z\",\n \"tipo\": \"string\",\n \"solicitante\": \"string\",\n \"referencia\": \"string\",\n \"indexPorFecha\": 0,\n \"docErrors\": [\n \"string\"\n ]\n }\n ],\n \"cuaderno\": {\n \"index\": 0,\n \"order\": 0,\n \"name\": \"string\",\n \"estadosProcesal\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"etapas\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"tipoProcedimiento\": \"string\"\n },\n \"audios\": [\n {\n \"numero\": 0,\n \"audio\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"docErrors\": [\n \"string\"\n ]\n }\n ],\n \"diligencias\": [\n {\n \"index\": 0,\n \"docIda\": \"string\",\n \"docVta\": \"string\",\n \"estado\": \"string\",\n \"rit\": \"string\",\n \"ruc\": \"string\",\n \"tipoDiligencia\": \"string\",\n \"referencia\": \"string\",\n \"destinatario\": \"string\",\n \"responsable\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"docErrors\": [\n \"string\"\n ],\n \"identityKey\": \"string\"\n }\n ],\n \"relaciones\": [\n {\n \"index\": 0,\n \"nombre\": \"string\",\n \"delito\": \"string\",\n \"estado\": \"string\",\n \"fechaCambioEstado\": \"2026-01-31T12:00:00Z\",\n \"identityKey\": \"string\"\n }\n ]\n }\n ]\n },\n \"documents\": [\n {\n \"documentRef\": \"string\",\n \"kind\": \"string\",\n \"cuaderno\": \"string\",\n \"folio\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"descripcion\": \"string\"\n }\n ],\n \"follow\": {\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"libro\": \"string\",\n \"val\": \"string\",\n \"year\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:lookup\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Descargar un documento de una consulta", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"documentRef\": \"\u003cdocumentRef\u003e\",\n \"lookupId\": \"\u003clookupId\u003e\"\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "causas", "consulta", "documento" ], "raw": "{{baseUrl}}/api/v1/causas/consulta/documento" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"expiresAt\": \"2026-01-31T12:00:00Z\",\n \"fileName\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:lookup\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get causa breakdown", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Get causa breakdown\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "get-cause-breakdown" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/get-cause-breakdown" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"byTeam\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"count\": 0\n }\n ],\n \"byResponsibleAttorney\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"count\": 0\n }\n ],\n \"untaggedCount\": 0,\n \"unassignedCount\": 0,\n \"canViewAllTeams\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get causa lineage", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseId\": \"\u003cCASE_ID\u003e\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "get-cause-lineage" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/get-cause-lineage" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"entries\": [\n {\n \"causaId\": \"string\",\n \"rol\": \"string\",\n \"competence\": \"string\",\n \"tribunal\": \"string\",\n \"caratulado\": \"string\",\n \"kind\": \"string\",\n \"direction\": \"string\",\n \"depth\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get ojv catalogs", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "ojv", "queries", "get-ojv-catalogs" ], "raw": "{{baseUrl}}/api/actions/ojv/queries/get-ojv-catalogs" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"competences\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"valueNumber\": \"string\"\n }\n ],\n \"courts\": [\n {\n \"value\": 0,\n \"label\": \"string\"\n }\n ],\n \"tribunals\": [\n {\n \"competence\": \"string\",\n \"tribunalId\": 0,\n \"corteId\": 0,\n \"name\": \"string\",\n \"courtLabel\": \"string\",\n \"competenceCode\": 0,\n \"altNames\": [\n \"string\"\n ]\n }\n ],\n \"rolTypesByCompetence\": {\n \"\u003ckey\u003e\": {}\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reference:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get total active tracked cases count", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "get-total-active-tracked-cases-count" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/get-total-active-tracked-cases-count" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"total\": 0\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get tracked case detail", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseId\": \"\u003cCASE_ID\u003e\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "get-tracked-case-detail" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/get-tracked-case-detail" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"trackedCase\": {\n \"aiAccessEnabled\": true,\n \"aiAccessOrgEnabled\": true,\n \"boletinConcursal\": {\n \"id\": \"string\",\n \"documentId\": \"string\",\n \"source\": \"L\",\n \"product\": \"liquidador\",\n \"estado\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"liquidador\": \"string\",\n \"publications\": 0\n },\n \"id\": \"string\",\n \"identifier\": \"string\",\n \"matchedByID\": true,\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"competence\": \"string\",\n \"active\": true,\n \"archived\": true,\n \"isPrivate\": true,\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"orgIds\": [\n \"string\"\n ],\n \"teamIds\": [\n \"string\"\n ],\n \"clients\": [\n {\n \"clientId\": \"string\",\n \"accessGranted\": true,\n \"lastCheck\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"suspendedOrgs\": [\n {\n \"orgId\": \"string\",\n \"oId\": \"string\",\n \"addedAt\": \"2026-01-31T12:00:00Z\",\n \"suspendedAt\": \"2026-01-31T12:00:00Z\",\n \"archivedAt\": \"2026-01-31T12:00:00Z\",\n \"archivedReason\": \"string\",\n \"archivedById\": \"string\"\n }\n ],\n \"createdAt\": \"string\",\n \"fechaIng\": \"2026-01-31T12:00:00Z\",\n \"lastUpdate\": \"2026-01-31T12:00:00Z\",\n \"successValidUntil\": \"2026-01-31T12:00:00Z\",\n \"status\": \"string\",\n \"errorCategory\": \"string\",\n \"textErrorDesc\": \"string\",\n \"daysWithNoChanges\": 0,\n \"lastChangeAt\": \"string\",\n \"latestMovementSummary\": \"string\",\n \"avgResolutionDays\": 0,\n \"lastResolutionAt\": \"2026-01-31T12:00:00Z\",\n \"notebooks\": [\n {\n \"id\": \"string\",\n \"index\": 0,\n \"order\": 0,\n \"name\": \"string\",\n \"defaultSection\": \"string\",\n \"historyCount\": 0,\n \"notificationCount\": 0,\n \"pendingCount\": 0,\n \"diligenceCount\": 0,\n \"relationCount\": 0,\n \"audioCount\": 0\n }\n ],\n \"defaultNotebook\": 0,\n \"notebookTotals\": {\n \"historyCount\": 0,\n \"notificationCount\": 0,\n \"pendingCount\": 0,\n \"diligenceCount\": 0,\n \"relationCount\": 0,\n \"audioCount\": 0\n },\n \"allNotebooksIndex\": 0,\n \"allowedSections\": [\n \"string\"\n ],\n \"receiverNotifications\": [\n {\n \"id\": \"string\",\n \"index\": 0,\n \"cuaderno\": \"string\",\n \"datosDelRetiro\": \"string\",\n \"fechaRetiro\": \"string\",\n \"estado\": \"string\",\n \"createdAt\": \"string\",\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"itemDesc\": \"string\",\n \"orgId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"historiaId\": \"string\",\n \"litiganteId\": \"string\",\n \"exhortoId\": \"string\",\n \"notificacionId\": \"string\",\n \"diligenciaId\": \"string\",\n \"relacionCausaId\": \"string\",\n \"escritoPorResolverId\": \"string\",\n \"plazoId\": \"string\",\n \"audioId\": \"string\",\n \"notificacionReceptorId\": \"string\",\n \"anexoRef\": \"string\"\n }\n ]\n }\n ],\n \"receiverNotificationsLen\": 0,\n \"audios\": [\n {\n \"id\": \"string\",\n \"numero\": 0,\n \"audio\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"notebook\": 0,\n \"createdAt\": \"string\",\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"itemDesc\": \"string\",\n \"orgId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"historiaId\": \"string\",\n \"litiganteId\": \"string\",\n \"exhortoId\": \"string\",\n \"notificacionId\": \"string\",\n \"diligenciaId\": \"string\",\n \"relacionCausaId\": \"string\",\n \"escritoPorResolverId\": \"string\",\n \"plazoId\": \"string\",\n \"audioId\": \"string\",\n \"notificacionReceptorId\": \"string\",\n \"anexoRef\": \"string\"\n }\n ]\n }\n ],\n \"audiosLen\": 0,\n \"linkedInternalCases\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"currentStateSlug\": \"string\",\n \"archived\": true,\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"fechaDeIng\": \"2026-01-31T12:00:00Z\",\n \"orgId\": \"string\"\n }\n ],\n \"linkedInternalCasesCount\": 0,\n \"basicInfo\": {\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"competence\": \"string\",\n \"fechaIng\": \"2026-01-31T12:00:00Z\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"tipoProcedimiento\": \"string\",\n \"ruc\": \"string\",\n \"formaDeInicio\": \"string\",\n \"relator\": \"string\",\n \"juezAsignado\": \"string\",\n \"tituloEjecutivo\": \"string\",\n \"certEnvioId\": \"string\",\n \"ebookId\": \"string\",\n \"estadosAdmin\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"estadosProcesal\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"etapas\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"ubicaciones\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"materias\": [\n {\n \"codigo\": \"string\",\n \"glosa\": \"string\",\n \"estado\": \"string\",\n \"fechaTermino\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"textoDemandas\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"source\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\"\n }\n ],\n \"anexos\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"source\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\"\n }\n ],\n \"docsCausa\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"source\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\"\n }\n ],\n \"attachments\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"source\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\"\n }\n ],\n \"observation\": [\n {\n \"field\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"notebookCount\": 0,\n \"litigantCount\": 0,\n \"exhortCount\": 0,\n \"deadlineCount\": 0\n },\n \"upcomingHearings\": [\n {\n \"startsAt\": \"2026-01-31T12:00:00Z\",\n \"kind\": \"string\",\n \"allDay\": true,\n \"source\": \"string\"\n }\n ]\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get tracked case document url", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseId\": \"\u003cCASE_ID\u003e\",\n \"path\": \"\u003cDOCUMENT_PATH\u003e\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "get-tracked-case-document-url" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/get-tracked-case-document-url" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"recoveryQueued\": true,\n \"url\": \"string\",\n \"previewUrl\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get tracked case section", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseId\": \"\u003cCASE_ID\u003e\",\n \"notebook\": -1,\n \"section\": \"default\",\n \"page\": 1,\n \"per_page\": 50\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "get-tracked-case-section" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/get-tracked-case-section" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"section\": {\n \"slug\": \"string\",\n \"notebook\": 0,\n \"allNotebooks\": true,\n \"total\": 0,\n \"pageCount\": 0,\n \"rows\": [\n {\n \"estado\": {},\n \"doc\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"fechaTermino\": \"2026-01-31T12:00:00Z\",\n \"fechaTramite\": \"2026-01-31T12:00:00Z\",\n \"id\": \"string\",\n \"order\": 0,\n \"folio\": \"string\",\n \"nulo\": true,\n \"reposicion\": true,\n \"mismoFolio\": 0,\n \"especial\": true,\n \"sala\": \"string\",\n \"certEnvioId\": \"string\",\n \"georref\": {\n \"latitud\": 0,\n \"longitud\": 0,\n \"lat\": 0,\n \"lng\": 0,\n \"corrector\": 0\n },\n \"anexoCount\": 0,\n \"anexos\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"source\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\",\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"itemDesc\": \"string\",\n \"orgId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"historiaId\": \"string\",\n \"litiganteId\": \"string\",\n \"exhortoId\": \"string\",\n \"notificacionId\": \"string\",\n \"diligenciaId\": \"string\",\n \"relacionCausaId\": \"string\",\n \"escritoPorResolverId\": \"string\",\n \"plazoId\": \"string\",\n \"audioId\": \"string\",\n \"notificacionReceptorId\": \"string\",\n \"anexoRef\": \"string\"\n }\n ]\n }\n ],\n \"anexoType\": \"string\",\n \"etapa\": \"string\",\n \"descTramite\": \"string\",\n \"segundaFechaTramite\": \"2026-01-31T12:00:00Z\",\n \"fechaRecepcion\": \"2026-01-31T12:00:00Z\",\n \"foja\": \"string\",\n \"conAudios\": true,\n \"rut\": \"string\",\n \"monto\": 0,\n \"cuadernoLiq\": \"string\",\n \"allDocsOk\": true,\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"itemDesc\": \"string\",\n \"orgId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"historiaId\": \"string\",\n \"litiganteId\": \"string\",\n \"exhortoId\": \"string\",\n \"notificacionId\": \"string\",\n \"diligenciaId\": \"string\",\n \"relacionCausaId\": \"string\",\n \"escritoPorResolverId\": \"string\",\n \"plazoId\": \"string\",\n \"audioId\": \"string\",\n \"notificacionReceptorId\": \"string\",\n \"anexoRef\": \"string\"\n }\n ],\n \"participante\": \"string\",\n \"persona\": \"string\",\n \"abogadoDefensor\": true,\n \"index\": 0,\n \"estadoNotif\": \"string\",\n \"tipoNotif\": \"string\",\n \"fechaAudiencia\": \"2026-01-31T12:00:00Z\",\n \"tipoPart\": \"string\",\n \"obsFallida\": \"string\",\n \"ruc\": \"string\",\n \"enteNotificador\": \"string\",\n \"notificationDetail\": [\n {\n \"idx\": 0,\n \"codigo\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"tipo\": \"string\",\n \"observación\": \"string\"\n }\n ],\n \"fechaIngreso\": \"2026-01-31T12:00:00Z\",\n \"tipo\": \"string\",\n \"solicitante\": \"string\",\n \"referencia\": \"string\",\n \"indexPorFecha\": 0,\n \"rolOrigen\": \"string\",\n \"tipoExhorto\": \"string\",\n \"documentCount\": 0,\n \"documentosExhortos\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"source\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\"\n }\n ],\n \"fechaOrdenaExhorto\": \"2026-01-31T12:00:00Z\",\n \"fechaIngresaExhorto\": \"2026-01-31T12:00:00Z\",\n \"rolDestino\": \"string\",\n \"tribunalDestino\": 0,\n \"estadoExhorto\": \"string\",\n \"tribunalOrigen\": \"string\",\n \"delito\": \"string\",\n \"fechaCambioEstado\": \"2026-01-31T12:00:00Z\",\n \"docIda\": \"string\",\n \"docVta\": \"string\",\n \"hasDocuments\": true,\n \"rit\": \"string\",\n \"tipoDiligencia\": \"string\",\n \"destinatario\": \"string\",\n \"responsable\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"glosa\": \"string\",\n \"tipoPlazo\": \"string\",\n \"ambitoAfectado\": \"string\",\n \"fechaInicio\": \"2026-01-31T12:00:00Z\",\n \"duracion\": \"string\",\n \"fechaSuspencion\": \"2026-01-31T12:00:00Z\",\n \"fechaReactivacion\": \"2026-01-31T12:00:00Z\",\n \"prestacion\": \"string\",\n \"fechaPrestacion\": \"2026-01-31T12:00:00Z\",\n \"fechaActualizar\": \"2026-01-31T12:00:00Z\",\n \"saldoDeuda\": 0,\n \"fechaLiq\": \"2026-01-31T12:00:00Z\",\n \"porcentajeReajuste\": 0,\n \"porcentajeInteres\": 0,\n \"source\": \"string\",\n \"pieza\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\",\n \"field\": \"string\",\n \"value\": \"string\",\n \"tribunalId\": 0,\n \"title\": \"string\",\n \"content\": \"string\",\n \"orgId\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"caratulado\": \"string\",\n \"currentStateSlug\": \"string\",\n \"archived\": true,\n \"fechaDeIng\": \"2026-01-31T12:00:00Z\",\n \"notebook\": 0,\n \"notebookName\": \"string\"\n }\n ],\n \"defaultSort\": \"string\",\n \"defaultSortDesc\": true,\n \"availableSections\": [\n \"string\"\n ]\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get tracked cases", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"page\": 1,\n \"per_page\": 25,\n \"sort\": \"updatedAt.desc\",\n \"rol\": \"\",\n \"caratulado\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "get-tracked-cases" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/get-tracked-cases" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causes\": [\n {\n \"id\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"competence\": \"SUPREMA\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"active\": true,\n \"archived\": true,\n \"archivedAt\": \"2026-01-31T12:00:00Z\",\n \"isPrivate\": true,\n \"status\": \"SUCCESS\",\n \"fechaIng\": \"2026-01-31T12:00:00Z\",\n \"lastUpdate\": \"2026-01-31T12:00:00Z\",\n \"lastChangeAt\": \"2026-01-31T12:00:00Z\",\n \"daysWithNoChanges\": 0,\n \"successValidUntil\": \"2026-01-31T12:00:00Z\",\n \"errorCategory\": \"OTHER\",\n \"textErrorDesc\": \"string\",\n \"orgIds\": [\n \"string\"\n ],\n \"teamIds\": [\n \"string\"\n ],\n \"clients\": [\n {\n \"clientId\": \"string\",\n \"cId\": \"string\",\n \"orgId\": \"string\",\n \"oId\": \"string\",\n \"accessGranted\": true,\n \"aG\": true,\n \"lastCheck\": \"2026-01-31T12:00:00Z\",\n \"lc\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"suspendedOrgs\": [\n {\n \"orgId\": \"string\",\n \"oId\": \"string\",\n \"addedAt\": \"2026-01-31T12:00:00Z\",\n \"suspendedAt\": \"2026-01-31T12:00:00Z\",\n \"archivedAt\": \"2026-01-31T12:00:00Z\",\n \"archivedReason\": \"string\",\n \"archivedById\": \"string\"\n }\n ],\n \"estadosProcesal\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"cuadernoCount\": 0,\n \"autoTracked\": true,\n \"relation\": {\n \"kind\": \"string\",\n \"parentRol\": \"string\",\n \"parentCausaId\": \"string\"\n }\n }\n ],\n \"pageCount\": 0,\n \"total\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get untagged causes", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"page\": 0,\n \"per_page\": 0,\n \"sort\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"operator\": \"\",\n \"rol\": \"\",\n \"caratulado\": \"\",\n \"tribunalId\": \"\",\n \"corteId\": \"\",\n \"suspendedOrgs\": \"\",\n \"clientIds\": \"\",\n \"folio\": \"\",\n \"tramite\": \"\",\n \"nombre\": \"\",\n \"competence\": \"\",\n \"boletinConcursal\": \"\",\n \"archived\": \"\",\n \"teamId\": \"\",\n \"assigneeUserId\": \"\",\n \"assigneeRole\": \"\",\n \"unassigned\": \"\",\n \"hideAutoRelated\": \"\",\n \"changedWithinDays\": \"\",\n \"createdWithinDays\": \"\",\n \"noClient\": \"\",\n \"unchangedForDays\": \"\"\n }\n ]\n}" }, "description": "Get untagged causes\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "get-untagged-causes" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/get-untagged-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causes\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"competence\": \"SUPREMA\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"fechaIng\": \"2026-01-31T12:00:00Z\",\n \"lastChangeAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"pageCount\": 0,\n \"total\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get untracked causa lineage", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "get-untracked-cause-lineage" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/get-untracked-cause-lineage" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"entries\": [\n {\n \"causaId\": \"string\",\n \"rol\": \"string\",\n \"competence\": \"string\",\n \"tribunal\": \"string\",\n \"caratulado\": \"string\",\n \"kind\": \"string\",\n \"sourceInternalCauseId\": \"string\",\n \"sourceInternalCauseName\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List queued tracked case searches", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"internalCaseId\": \"\",\n \"creationKey\": \"\",\n \"all\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "queries", "list-queued-tracked-case-searches" ], "raw": "{{baseUrl}}/api/actions/case-tracking/queries/list-queued-tracked-case-searches" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"items\": [\n {\n \"id\": \"string\",\n \"label\": \"string\",\n \"state\": \"string\",\n \"attempts\": 0,\n \"reason\": \"string\",\n \"createdAt\": \"string\",\n \"causaId\": \"string\",\n \"lastError\": \"string\",\n \"finishedAt\": \"string\",\n \"nextAttemptAt\": \"string\"\n }\n ],\n \"openCount\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Reabrir una consulta", "request": { "description": "Reabrir una consulta\n\nAuthentication: developer API key with `causas:lookup` scope. A consulta of the last 7 days, in full. Free.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "causas", "consulta", "{lookupId}" ], "raw": "{{baseUrl}}/api/v1/causas/consulta/{lookupId}" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"items\": [\n {\n \"lookupId\": \"string\",\n \"competence\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"tribunal\": \"string\",\n \"source\": \"string\",\n \"fetchedAt\": \"string\"\n }\n ],\n \"lookupId\": \"string\",\n \"fetchedAt\": \"2026-01-31T12:00:00Z\",\n \"cached\": true,\n \"causa\": \"string\",\n \"documents\": \"string\",\n \"follow\": {\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"libro\": \"string\",\n \"val\": \"string\",\n \"year\": \"string\"\n },\n \"prices\": {\n \"consulta\": 0,\n \"documento\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:lookup\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Search ojv causes", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\",\n \"\",\n []\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "queries", "search-ojv-causes" ], "raw": "{{baseUrl}}/api/actions/internal-cases/queries/search-ojv-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "[\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"competence\": \"string\",\n \"caratulado\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0\n }\n]", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Accept causa lineage suggestion", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"internalCauseId\": \"\",\n \"causaId\": \"\",\n \"decision\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "accept-cause-lineage-suggestion" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/accept-cause-lineage-suggestion" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Archive tracked cases", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseIds\": [\n \"\u003cCASE_ID\u003e\"\n ],\n \"archived\": true,\n \"reason\": \"Causa terminada\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "archive-tracked-cases" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/archive-tracked-cases" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"archived\": 0,\n \"requested\": 0,\n \"skipped\": [\n {\n \"caseId\": \"string\",\n \"reason\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Assign causa team", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\",\n \"teamId\": \"\"\n }\n ]\n}" }, "description": "Assign causa team\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "assign-cause-team" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/assign-cause-team" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Assign causa team bulk", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaIds\": [],\n \"teamId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "assign-cause-team-bulk" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/assign-cause-team-bulk" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"updated\": 0,\n \"requested\": 0,\n \"skipped\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Cancel queued tracked case search", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "cancel-queued-tracked-case-search" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/cancel-queued-tracked-case-search" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create tracked case", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"orgId\": \"\u003cORG_ID\u003e\",\n \"teamIds\": [],\n \"competence\": \"CIVIL\",\n \"libro\": \"C\",\n \"val\": \"1234\",\n \"year\": \"2024\",\n \"corteId\": 90,\n \"tribunalId\": 259,\n \"clientIds\": [],\n \"private\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "create-tracked-case" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/create-tracked-case" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"cause\": {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"isPrivate\": true,\n \"caratulado\": \"string\"\n },\n \"internalCase\": {\n \"id\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete tracked case bitacora", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\u003cBITACORA_ID\u003e\",\n \"caseId\": \"\u003cCASE_ID\u003e\",\n \"orgId\": \"\u003cORG_ID\u003e\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "bitacora-mutations", "delete-tracked-case-bitacora" ], "raw": "{{baseUrl}}/api/actions/case-tracking/bitacora-mutations/delete-tracked-case-bitacora" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Generate cause ebook", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseId\": \"\"\n }\n ]\n}" }, "description": "Generate cause ebook\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "generate-cause-ebook" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/generate-cause-ebook" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"path\": \"string\",\n \"fojas\": 0,\n \"attached\": 0,\n \"bytes\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Queue tracked case search", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"search\": {\n \"orgId\": \"\",\n \"teamIds\": [],\n \"competence\": \"\",\n \"libro\": \"\",\n \"val\": \"\",\n \"year\": \"\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"clientIds\": [],\n \"private\": false\n },\n \"label\": \"\",\n \"internalCaseId\": \"\",\n \"creationKey\": \"\",\n \"reason\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "queue-tracked-case-search" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/queue-tracked-case-search" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"alreadyQueued\": true,\n \"reason\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Refresh tracked case detail", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseId\": \"\u003cCASE_ID\u003e\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "refresh-tracked-case-detail" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/refresh-tracked-case-detail" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"result\": {\n \"status\": \"string\",\n \"causeName\": \"string\"\n },\n \"status\": \"string\",\n \"refreshedAt\": \"string\",\n \"trackedCase\": {\n \"boletinConcursal\": {\n \"id\": \"string\",\n \"documentId\": \"string\",\n \"source\": \"L\",\n \"product\": \"liquidador\",\n \"estado\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"liquidador\": \"string\",\n \"publications\": 0\n },\n \"id\": \"string\",\n \"status\": \"string\",\n \"successValidUntil\": \"2026-01-31T12:00:00Z\",\n \"lastUpdate\": \"2026-01-31T12:00:00Z\",\n \"lastChangeAt\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Update queued tracked case search", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"op\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "mutations", "update-queued-tracked-case-search" ], "raw": "{{baseUrl}}/api/actions/case-tracking/mutations/update-queued-tracked-case-search" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upsert tracked case bitacora", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseId\": \"\u003cCASE_ID\u003e\",\n \"orgId\": \"\u003cORG_ID\u003e\",\n \"title\": \"Llamada con cliente\",\n \"content\": \"Se acordó presentar escrito.\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "bitacora-mutations", "upsert-tracked-case-bitacora" ], "raw": "{{baseUrl}}/api/actions/case-tracking/bitacora-mutations/upsert-tracked-case-bitacora" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"bitacora\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"orgId\": \"string\",\n \"causeId\": \"string\",\n \"modifiedById\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upsert tracked case note", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseId\": \"\",\n \"orgId\": \"\",\n \"relationName\": \"\",\n \"relationId\": \"\",\n \"itemDesc\": \"\",\n \"text\": \"\",\n \"cuadernoName\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-tracking", "note-mutations", "upsert-tracked-case-note" ], "raw": "{{baseUrl}}/api/actions/case-tracking/note-mutations/upsert-tracked-case-note" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"note\": {\n \"id\": \"string\",\n \"text\": \"string\",\n \"itemDesc\": \"string\",\n \"orgId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"historiaId\": \"string\",\n \"litiganteId\": \"string\",\n \"exhortoId\": \"string\",\n \"notificacionId\": \"string\",\n \"diligenciaId\": \"string\",\n \"relacionCausaId\": \"string\",\n \"escritoPorResolverId\": \"string\",\n \"plazoId\": \"string\",\n \"audioId\": \"string\",\n \"notificacionReceptorId\": \"string\",\n \"anexoRef\": \"string\",\n \"causeId\": \"string\",\n \"cuadernoName\": \"string\",\n \"modifiedById\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "PJUD causas" }, { "item": [ { "name": "Answer batch gaps", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"batchId\": \"\",\n \"shared\": {},\n \"perItem\": {}\n }\n ]\n}" }, "description": "Answer batch gaps\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "mutations", "answer-batch-gaps" ], "raw": "{{baseUrl}}/api/actions/writings/mutations/answer-batch-gaps" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"batch\": {\n \"id\": \"string\",\n \"source\": \"plantilla\",\n \"plantillaId\": \"string\",\n \"tipo\": \"string\",\n \"titulo\": \"string\",\n \"state\": \"DRAFTING\",\n \"sharedValues\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"createdById\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"confirmedById\": \"string\",\n \"confirmedAt\": \"2026-01-31T12:00:00Z\",\n \"requiereIA\": true,\n \"canal\": \"string\"\n },\n \"items\": [\n {\n \"id\": \"string\",\n \"causaRef\": \"string\",\n \"causaKind\": \"bc\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"caratula\": \"string\",\n \"escritoKind\": \"generic\",\n \"escritoRef\": \"string\",\n \"state\": \"PENDING\",\n \"error\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"shared\": true\n }\n ],\n \"answers\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"channels\": [\n {\n \"canal\": \"bc\",\n \"jobId\": \"string\",\n \"state\": \"string\",\n \"status\": \"pending\",\n \"error\": \"string\",\n \"folio\": \"string\",\n \"numeroIngreso\": \"string\",\n \"enabled\": true\n }\n ],\n \"filable\": true,\n \"hasPreview\": true\n }\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"sharedGaps\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"items\": 0\n }\n ],\n \"filableCount\": 0,\n \"pjudFilingEnabled\": true,\n \"editable\": true,\n \"generating\": true,\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Change internal case state", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"internalCauseId\": \"\",\n \"newStateSlug\": \"\",\n \"auto\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "change-internal-case-state" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/change-internal-case-state" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Compute deadline", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"startDate\": \"\",\n \"days\": 0,\n \"mode\": \"\",\n \"locality\": \"\",\n \"template\": \"\",\n \"procedure\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "deadlines", "compute-deadline" ], "raw": "{{baseUrl}}/api/actions/deadlines/compute-deadline" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"dueDate\": \"string\",\n \"counted\": 0,\n \"excluded\": [\n {\n \"date\": \"string\",\n \"reason\": \"string\"\n }\n ],\n \"mode\": \"string\",\n \"days\": 0,\n \"sources\": [\n {\n \"title\": \"string\",\n \"url\": \"string\"\n }\n ],\n \"calendarCoverage\": \"string\",\n \"warnings\": [\n \"string\"\n ],\n \"rule\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reference:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Download a completed case activity export", "request": { "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.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "case-activity", "exports", "download" ], "query": [ { "description": "Export job id.", "disabled": false, "key": "jobId", "value": "" } ], "raw": "{{baseUrl}}/api/case-activity/exports/download?jobId=" } }, "response": [ { "_postman_previewlanguage": "json", "body": "\u003capplication/octet-stream file\u003e", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success (file)", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Download a tracked case document", "request": { "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.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "case-tracking", "documents", "view" ], "query": [ { "description": "Organization-visible tracked case id.", "disabled": false, "key": "caseId", "value": "" }, { "description": "Document storage path from case data.", "disabled": false, "key": "path", "value": "" } ], "raw": "{{baseUrl}}/api/case-tracking/documents/view?caseId=\u0026path=" } }, "response": [ { "_postman_previewlanguage": "json", "body": "\u003capplication/octet-stream file\u003e", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success (file)", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Download case activity documents as an archive", "request": { "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.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "case-activity", "documents", "archive" ], "query": [ { "description": "Document-bearing activity section.", "disabled": false, "key": "section", "value": "" }, { "description": "Start date.", "disabled": true, "key": "from", "value": "" }, { "description": "End date.", "disabled": true, "key": "to", "value": "" } ], "raw": "{{baseUrl}}/api/case-activity/documents/archive?section=" } }, "response": [ { "_postman_previewlanguage": "json", "body": "\u003capplication/zip file\u003e", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success (file)", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get case activity document url", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"section\": \"historia\",\n \"id\": \"\u003cMOVEMENT_ID\u003e\",\n \"path\": \"\u003cDOCUMENT_PATH\u003e\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-activity", "queries", "get-case-activity-document-url" ], "raw": "{{baseUrl}}/api/actions/case-activity/queries/get-case-activity-document-url" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"recoveryQueued\": true,\n \"url\": \"string\",\n \"previewUrl\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get case activity export queue", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"limit\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-activity", "queries", "get-case-activity-export-queue" ], "raw": "{{baseUrl}}/api/actions/case-activity/queries/get-case-activity-export-queue" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"section\": \"string\",\n \"from\": \"string\",\n \"to\": \"string\",\n \"state\": \"string\",\n \"attempts\": 0,\n \"progressCurrent\": 0,\n \"progressTotal\": 0,\n \"errorMessage\": \"string\",\n \"fileName\": \"string\",\n \"bytes\": 0,\n \"downloadable\": true,\n \"createdAt\": \"string\",\n \"completedAt\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get case activity section counts", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"from\": \"\",\n \"to\": \"\",\n \"hideLiquidacionCausas\": false,\n \"hideReviewed\": false,\n \"hideAutoRelated\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-activity", "queries", "get-case-activity-section-counts" ], "raw": "{{baseUrl}}/api/actions/case-activity/queries/get-case-activity-section-counts" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"counts\": {\n \"historia\": 0,\n \"notificacion\": 0,\n \"escritoPorResolver\": 0,\n \"exhorto\": 0,\n \"notificacionReceptor\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get case law document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003cjurisID\u003e\",\n {\n \"includeHtml\": false,\n \"buscador\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-law", "get-case-law-document" ], "raw": "{{baseUrl}}/api/actions/case-law/get-case-law-document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"jurisId\": \"string\",\n \"buscador\": \"string\",\n \"caratulado\": \"string\",\n \"caratuladoAnon\": \"string\",\n \"corte\": \"string\",\n \"sala\": \"string\",\n \"rolEraApe\": \"string\",\n \"resultadoRecurso\": \"string\",\n \"fecSentenciaSup\": \"string\",\n \"urlAccesoSentencia\": \"string\",\n \"urlCortaAccesoSentencia\": \"string\",\n \"citaBibliografica\": \"string\",\n \"privilegio\": \"string\",\n \"titulo\": \"string\",\n \"tribunal\": \"string\",\n \"rol\": \"string\",\n \"materia\": \"string\",\n \"origen\": \"string\",\n \"resultado\": \"string\",\n \"descriptores\": [\n \"string\"\n ],\n \"normas\": [\n \"string\"\n ],\n \"ministros\": [\n \"string\"\n ],\n \"redactor\": \"string\",\n \"textoSentenciaText\": \"string\",\n \"textoSentenciaAnonText\": \"string\",\n \"textoSentenciaHtml\": \"string\",\n \"textoSentenciaAnonHtml\": \"string\",\n \"textoSentenciaPreview\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reference:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get escrito batch", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"batchId\": \"\"\n }\n ]\n}" }, "description": "Get escrito batch\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "queries", "get-escrito-batch" ], "raw": "{{baseUrl}}/api/actions/writings/queries/get-escrito-batch" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"batch\": {\n \"id\": \"string\",\n \"source\": \"plantilla\",\n \"plantillaId\": \"string\",\n \"tipo\": \"string\",\n \"titulo\": \"string\",\n \"state\": \"DRAFTING\",\n \"sharedValues\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"createdById\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"confirmedById\": \"string\",\n \"confirmedAt\": \"2026-01-31T12:00:00Z\",\n \"requiereIA\": true,\n \"canal\": \"string\"\n },\n \"items\": [\n {\n \"id\": \"string\",\n \"causaRef\": \"string\",\n \"causaKind\": \"bc\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"caratula\": \"string\",\n \"escritoKind\": \"generic\",\n \"escritoRef\": \"string\",\n \"state\": \"PENDING\",\n \"error\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"shared\": true\n }\n ],\n \"answers\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"channels\": [\n {\n \"canal\": \"bc\",\n \"jobId\": \"string\",\n \"state\": \"string\",\n \"status\": \"pending\",\n \"error\": \"string\",\n \"folio\": \"string\",\n \"numeroIngreso\": \"string\",\n \"enabled\": true\n }\n ],\n \"filable\": true,\n \"hasPreview\": true\n }\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"sharedGaps\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"items\": 0\n }\n ],\n \"filableCount\": 0,\n \"pjudFilingEnabled\": true,\n \"editable\": true,\n \"generating\": true,\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get escrito batch document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"itemId\": \"\",\n \"format\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "queries", "get-escrito-batch-document" ], "raw": "{{baseUrl}}/api/actions/writings/queries/get-escrito-batch-document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"previewUrl\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get expediente feed", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"cause\": \"\",\n \"page\": 0,\n \"documents\": false,\n \"search\": \"\",\n \"category\": \"\"\n }\n ]\n}" }, "description": "Get expediente feed\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "expedientes", "workspace", "get-expediente-feed" ], "raw": "{{baseUrl}}/api/actions/expedientes/workspace/get-expediente-feed" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"id\": \"string\",\n \"relatedCauseId\": \"string\",\n \"source\": \"OJV\",\n \"targetId\": \"string\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"path\": \"string\",\n \"documentId\": \"string\",\n \"detail\": {},\n \"total\": 0\n }\n ],\n \"total\": 0,\n \"pageCount\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get internal case detail", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003cINTERNAL_CASE_ID\u003e\"\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "queries", "get-internal-case-detail" ], "raw": "{{baseUrl}}/api/actions/internal-cases/queries/get-internal-case-detail" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"internalCase\": {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"orgName\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"description\": \"string\",\n \"fechaDeIng\": \"2026-01-31T12:00:00Z\",\n \"region\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"teamIds\": [\n \"string\"\n ],\n \"createdById\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ],\n \"participants\": {},\n \"jpl\": \"string\",\n \"currentStateSlug\": \"string\",\n \"states\": [\n {\n \"stateSlug\": \"string\",\n \"stateName\": \"string\",\n \"stateColor\": \"string\",\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"changedById\": \"string\",\n \"counter\": 0\n }\n ],\n \"tagSlugs\": [\n \"string\"\n ],\n \"metadata\": {},\n \"archived\": true,\n \"aiAccessEnabled\": true,\n \"aiAccessOrgEnabled\": true,\n \"relatedCauses\": [\n {\n \"id\": \"string\",\n \"displayName\": \"string\",\n \"order\": 0,\n \"type\": \"string\",\n \"source\": \"string\",\n \"identityKey\": \"string\",\n \"targetKind\": \"string\",\n \"targetId\": \"string\",\n \"snapshot\": true,\n \"relation\": {\n \"kind\": \"string\",\n \"parentRol\": \"string\",\n \"parentCausaId\": \"string\"\n },\n \"autoTracked\": true\n }\n ],\n \"folders\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"parentFolderId\": \"string\",\n \"relatedCauseId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"documents\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"url\": \"string\",\n \"size\": 0,\n \"mimeType\": \"string\",\n \"description\": \"string\",\n \"folderId\": \"string\",\n \"relatedCauseId\": true,\n \"uploadState\": true,\n \"uploadedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"timeEntries\": [\n {\n \"id\": \"string\",\n \"entryDate\": \"2026-01-31T12:00:00Z\",\n \"minutes\": 0,\n \"description\": \"string\",\n \"billable\": true,\n \"hourlyRate\": 0,\n \"userId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"costEntries\": [\n {\n \"id\": \"string\",\n \"incurredAt\": \"2026-01-31T12:00:00Z\",\n \"category\": \"string\",\n \"amount\": 0,\n \"currency\": \"string\",\n \"vendor\": \"string\",\n \"description\": \"string\",\n \"billable\": true,\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"rollups\": {\n \"totalTrackedMinutes\": 0,\n \"totalTrackedCost\": 0,\n \"documentCount\": 0,\n \"relatedCauseCount\": 0\n }\n },\n \"settings\": {\n \"states\": [\n {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"color\": \"string\"\n }\n ],\n \"tags\": [\n {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"color\": \"string\"\n }\n ],\n \"fields\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"type\": \"string\",\n \"required\": true,\n \"placeholder\": \"string\",\n \"options\": [\n \"string\"\n ]\n }\n ],\n \"users\": [\n {\n \"id\": \"string\",\n \"n\": \"string\",\n \"e\": \"string\",\n \"r\": \"string\",\n \"inv\": \"string\",\n \"pc\": true,\n \"it\": [\n 0\n ]\n }\n ]\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get internal case settings", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "queries", "get-internal-case-settings" ], "raw": "{{baseUrl}}/api/actions/internal-cases/queries/get-internal-case-settings" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"organization\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"canEdit\": true,\n \"states\": [\n {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"color\": \"string\"\n }\n ],\n \"tags\": [\n {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"color\": \"string\"\n }\n ],\n \"fields\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"type\": \"string\",\n \"required\": true,\n \"placeholder\": \"string\",\n \"options\": [\n \"string\"\n ]\n }\n ],\n \"users\": [\n {\n \"id\": \"string\",\n \"n\": \"string\",\n \"e\": \"string\",\n \"r\": \"string\",\n \"inv\": \"string\",\n \"pc\": true,\n \"it\": [\n 0\n ]\n }\n ],\n \"teams\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ]\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get internal cases", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"page\": 1,\n \"per_page\": 25,\n \"search\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "queries", "get-internal-cases" ], "raw": "{{baseUrl}}/api/actions/internal-cases/queries/get-internal-cases" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"internalCases\": [\n {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"organizationName\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"description\": \"string\",\n \"fechaDeIng\": \"2026-01-31T12:00:00Z\",\n \"region\": \"string\",\n \"currentStateSlug\": \"string\",\n \"tagSlugs\": [\n \"string\"\n ],\n \"metadata\": {},\n \"states\": [\n {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"color\": \"string\"\n }\n ],\n \"organizationTags\": [\n {\n \"slug\": \"string\",\n \"name\": \"string\",\n \"color\": \"string\"\n }\n ],\n \"archived\": true,\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"assignedUserIds\": [\n \"string\"\n ],\n \"teamIds\": [\n \"string\"\n ],\n \"relatedCauseCount\": 0,\n \"documentCount\": 0,\n \"totalTrackedMinutes\": 0,\n \"totalTrackedCost\": 0\n }\n ],\n \"pageCount\": 0,\n \"total\": 0,\n \"representedCauses\": 0,\n \"coverage\": {\n \"status\": \"string\",\n \"total\": 0,\n \"represented\": 0,\n \"pending\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get linked causa people", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cause-assignments", "queries", "get-linked-cause-people" ], "raw": "{{baseUrl}}/api/actions/cause-assignments/queries/get-linked-cause-people" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"people\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\",\n \"roles\": [\n \"string\"\n ]\n }\n ],\n \"teams\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"assigned\": true\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get total active internal cases count", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "queries", "get-total-active-internal-cases-count" ], "raw": "{{baseUrl}}/api/actions/internal-cases/queries/get-total-active-internal-cases-count" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"total\": 0\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List bulk causas", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"source\": \"\",\n \"search\": \"\",\n \"procedimiento\": \"\",\n \"tribunal\": \"\",\n \"estado\": \"\",\n \"kind\": \"\"\n }\n ]\n}" }, "description": "List bulk causas\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "queries", "list-bulk-causes" ], "raw": "{{baseUrl}}/api/actions/writings/queries/list-bulk-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"ref\": \"string\",\n \"kind\": \"string\",\n \"id\": \"string\",\n \"causaId\": \"string\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"caratula\": \"string\",\n \"procedimiento\": \"string\",\n \"estado\": \"string\",\n \"terminada\": true\n }\n ],\n \"total\": 0,\n \"truncated\": true,\n \"procedimientos\": [\n \"string\"\n ],\n \"tribunales\": [\n \"string\"\n ],\n \"maxCausas\": 0,\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List case law documents", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"buscador\": \"\",\n \"page\": 0,\n \"pageSize\": 0,\n \"q\": \"\",\n \"dateFrom\": \"\",\n \"dateTo\": \"\",\n \"includeTotal\": false,\n \"cursor\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-law", "list-case-law-documents" ], "raw": "{{baseUrl}}/api/actions/case-law/list-case-law-documents" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"page\": 0,\n \"pageSize\": 0,\n \"total\": 0,\n \"totalPages\": 0,\n \"totalCapped\": true,\n \"items\": [\n {\n \"jurisId\": \"string\",\n \"buscador\": \"string\",\n \"caratulado\": \"string\",\n \"caratuladoAnon\": \"string\",\n \"corte\": \"string\",\n \"sala\": \"string\",\n \"rolEraApe\": \"string\",\n \"resultadoRecurso\": \"string\",\n \"fecSentenciaSup\": \"string\",\n \"urlAccesoSentencia\": \"string\",\n \"urlCortaAccesoSentencia\": \"string\",\n \"citaBibliografica\": \"string\",\n \"privilegio\": \"string\",\n \"snippet\": \"string\",\n \"titulo\": \"string\",\n \"tribunal\": \"string\",\n \"rol\": \"string\",\n \"materia\": \"string\",\n \"origen\": \"string\",\n \"resultado\": \"string\",\n \"descriptores\": [\n \"string\"\n ]\n }\n ],\n \"nextCursor\": \"string\",\n \"hasMore\": true\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reference:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List escrito batches", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "List escrito batches\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "queries", "list-escrito-batches" ], "raw": "{{baseUrl}}/api/actions/writings/queries/list-escrito-batches" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"batches\": [\n {\n \"id\": \"string\",\n \"source\": \"string\",\n \"plantillaId\": \"string\",\n \"tipo\": \"string\",\n \"titulo\": \"string\",\n \"state\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"confirmedAt\": \"2026-01-31T12:00:00Z\",\n \"total\": 0,\n \"counts\": {\n \"\u003ckey\u003e\": 0\n }\n }\n ],\n \"plantillas\": [\n {\n \"id\": \"string\",\n \"nombre\": \"string\",\n \"requiereIA\": true,\n \"canal\": \"bc\",\n \"instruccion\": \"string\"\n }\n ],\n \"tipos\": [\n {\n \"tipo\": \"string\",\n \"label\": \"string\",\n \"labelEn\": \"string\"\n }\n ],\n \"maxCausas\": 0,\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List escrito filings", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"escritoKind\": \"\",\n \"escritoRefs\": [],\n \"state\": \"\"\n }\n ]\n}" }, "description": "List escrito filings\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "queries", "list-escrito-filings" ], "raw": "{{baseUrl}}/api/actions/writings/queries/list-escrito-filings" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"filings\": [\n {\n \"id\": \"string\",\n \"escritoKind\": \"generic\",\n \"escritoRef\": \"string\",\n \"causaId\": \"string\",\n \"canal\": \"bc\",\n \"state\": \"PENDING\",\n \"attempts\": 0,\n \"error\": \"string\",\n \"result\": {},\n \"confirmedById\": \"string\",\n \"confirmedAt\": \"2026-01-31T12:00:00Z\",\n \"submitDispatchedAt\": \"2026-01-31T12:00:00Z\",\n \"boletinUploadJobId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"status\": \"pending\"\n }\n ],\n \"pjudFilingEnabled\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Read organization filing configuration", "request": { "description": "Read organization filing configuration\n\nAuthentication: developer API key with `documents:read` scope.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "escritos", "config" ], "raw": "{{baseUrl}}/api/escritos/config" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"version\": 0,\n \"global\": {\n \"liquidador\": \"string\",\n \"liquidadorRut\": \"string\",\n \"liquidadorDomicilio\": \"string\",\n \"liquidadorCorreo\": \"string\",\n \"firmaModo\": \"string\",\n \"abogado\": \"string\",\n \"abogadoRut\": \"string\",\n \"frasesTribunal\": \"string\",\n \"formulaCierre\": \"string\",\n \"otrosiesFijos\": [\n \"string\"\n ],\n \"criteriosGenerales\": \"string\"\n },\n \"tipos\": [\n {\n \"tipo\": \"string\",\n \"label\": \"string\",\n \"labelEn\": \"string\",\n \"publicationType\": \"string\",\n \"draftKind\": \"string\",\n \"sumaPorDefecto\": \"string\",\n \"enabled\": true,\n \"autoDraft\": true,\n \"criterios\": \"string\",\n \"otrosiesFijos\": [\n \"string\"\n ],\n \"preguntarAntes\": true,\n \"sumaEstandar\": \"string\"\n }\n ],\n \"plantillas\": [\n {\n \"id\": \"string\",\n \"nombre\": \"string\",\n \"publicationType\": \"string\",\n \"canal\": \"auto\",\n \"instruccion\": \"string\",\n \"texto\": \"string\",\n \"requiereIA\": true,\n \"preguntas\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\"\n }\n ]\n }\n ],\n \"variables\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\"\n }\n ],\n \"organizationId\": \"string\",\n \"organizationName\": \"string\",\n \"canEdit\": true\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Replace related causes", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"internalCauseId\": \"\",\n \"relatedCauses\": []\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "replace-related-causes" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/replace-related-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Resolve bc expediente", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"orgId\": \"\",\n \"boletinId\": \"\"\n }\n ]\n}" }, "description": "Resolve bc expediente\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "expedientes", "workspace", "resolve-bc-expediente" ], "raw": "{{baseUrl}}/api/actions/expedientes/workspace/resolve-bc-expediente" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"expedienteId\": \"string\",\n \"relatedCauseId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Resolve causa expediente", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"orgId\": \"\",\n \"causaId\": \"\",\n \"type\": \"\"\n }\n ]\n}" }, "description": "Resolve causa expediente\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "expedientes", "workspace", "resolve-cause-expediente" ], "raw": "{{baseUrl}}/api/actions/expedientes/workspace/resolve-cause-expediente" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"expedienteId\": \"string\",\n \"relatedCauseId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Search expediente causes", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"orgId\": \"\",\n \"search\": \"\",\n \"source\": \"\"\n }\n ]\n}" }, "description": "Search expediente causes\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "expedientes", "workspace", "search-expediente-causes" ], "raw": "{{baseUrl}}/api/actions/expedientes/workspace/search-expediente-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causes\": [\n {\n \"type\": \"OJV\",\n \"targetId\": \"string\",\n \"targetKind\": \"CAUSE\",\n \"source\": \"string\",\n \"snapshot\": {},\n \"expedientes\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"targetId\": \"string\"\n }\n ]\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Search internal cases for task", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\",\n \"\",\n \"\"\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "helpers", "search-internal-cases-for-task" ], "raw": "{{baseUrl}}/api/actions/internal-cases/helpers/search-internal-cases-for-task" } }, "response": [ { "_postman_previewlanguage": "json", "body": "[\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"states\": [\n {\n \"stateSlug\": \"string\",\n \"stateName\": \"string\",\n \"stateColor\": \"string\",\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"changedById\": \"string\",\n \"counter\": 0\n }\n ]\n }\n]", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Add document reference", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"internalCauseId\": \"\",\n \"folderId\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"mimeType\": \"\",\n \"description\": \"\",\n \"size\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "add-document-reference" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/add-document-reference" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true,\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Archive internal case", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\",\n false\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "archive-internal-case" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/archive-internal-case" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Assign internal case team", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"internalCaseIds\": [],\n \"teamId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "assign-internal-case-team" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/assign-internal-case-team" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"updated\": 0,\n \"requested\": 0,\n \"skipped\": [\n \"string\"\n ],\n \"causasTagged\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Confirm escrito batch", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"batchId\": \"\",\n \"confirmed\": false,\n \"confirmedCount\": 0\n }\n ]\n}" }, "description": "Confirm escrito batch\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "mutations", "confirm-escrito-batch" ], "raw": "{{baseUrl}}/api/actions/writings/mutations/confirm-escrito-batch" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"batch\": {\n \"id\": \"string\",\n \"source\": \"plantilla\",\n \"plantillaId\": \"string\",\n \"tipo\": \"string\",\n \"titulo\": \"string\",\n \"state\": \"DRAFTING\",\n \"sharedValues\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"createdById\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"confirmedById\": \"string\",\n \"confirmedAt\": \"2026-01-31T12:00:00Z\",\n \"requiereIA\": true,\n \"canal\": \"string\"\n },\n \"items\": [\n {\n \"id\": \"string\",\n \"causaRef\": \"string\",\n \"causaKind\": \"bc\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"caratula\": \"string\",\n \"escritoKind\": \"generic\",\n \"escritoRef\": \"string\",\n \"state\": \"PENDING\",\n \"error\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"shared\": true\n }\n ],\n \"answers\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"channels\": [\n {\n \"canal\": \"bc\",\n \"jobId\": \"string\",\n \"state\": \"string\",\n \"status\": \"pending\",\n \"error\": \"string\",\n \"folio\": \"string\",\n \"numeroIngreso\": \"string\",\n \"enabled\": true\n }\n ],\n \"filable\": true,\n \"hasPreview\": true\n }\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"sharedGaps\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"items\": 0\n }\n ],\n \"filableCount\": 0,\n \"pjudFilingEnabled\": true,\n \"editable\": true,\n \"generating\": true,\n \"canManage\": true,\n \"confirmation\": {\n \"queued\": 0,\n \"failed\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Confirm escrito filings", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"confirmed\": false,\n \"items\": []\n }\n ]\n}" }, "description": "Confirm escrito filings\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "mutations", "confirm-escrito-filings" ], "raw": "{{baseUrl}}/api/actions/writings/mutations/confirm-escrito-filings" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"results\": [\n {\n \"escritoKind\": \"string\",\n \"escritoRef\": \"string\",\n \"canales\": [\n {\n \"canal\": \"string\",\n \"jobId\": \"string\",\n \"state\": \"string\",\n \"error\": \"string\"\n }\n ],\n \"error\": \"string\"\n }\n ],\n \"pjudFilingEnabled\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create causa assignment", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\",\n \"role\": \"\",\n \"userId\": \"\",\n \"teamId\": \"\"\n }\n ]\n}" }, "description": "Create causa assignment\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cause-assignments", "mutations", "create-cause-assignment" ], "raw": "{{baseUrl}}/api/actions/cause-assignments/mutations/create-cause-assignment" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"errorEn\": \"string\",\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create cost entry", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"internalCauseId\": \"\",\n \"incurredAt\": \"\",\n \"category\": \"\",\n \"amount\": 0,\n \"currency\": \"\",\n \"vendor\": \"\",\n \"description\": \"\",\n \"billable\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "create-cost-entry" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/create-cost-entry" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create escrito batch", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"source\": \"\",\n \"plantillaId\": \"\",\n \"tipo\": \"\",\n \"causaRefs\": [],\n \"titulo\": \"\"\n }\n ]\n}" }, "description": "Create escrito batch\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "mutations", "create-escrito-batch" ], "raw": "{{baseUrl}}/api/actions/writings/mutations/create-escrito-batch" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"batch\": {\n \"id\": \"string\",\n \"source\": \"plantilla\",\n \"plantillaId\": \"string\",\n \"tipo\": \"string\",\n \"titulo\": \"string\",\n \"state\": \"DRAFTING\",\n \"sharedValues\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"createdById\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"confirmedById\": \"string\",\n \"confirmedAt\": \"2026-01-31T12:00:00Z\",\n \"requiereIA\": true,\n \"canal\": \"string\"\n },\n \"items\": [\n {\n \"id\": \"string\",\n \"causaRef\": \"string\",\n \"causaKind\": \"bc\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"caratula\": \"string\",\n \"escritoKind\": \"generic\",\n \"escritoRef\": \"string\",\n \"state\": \"PENDING\",\n \"error\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"shared\": true\n }\n ],\n \"answers\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"channels\": [\n {\n \"canal\": \"bc\",\n \"jobId\": \"string\",\n \"state\": \"string\",\n \"status\": \"pending\",\n \"error\": \"string\",\n \"folio\": \"string\",\n \"numeroIngreso\": \"string\",\n \"enabled\": true\n }\n ],\n \"filable\": true,\n \"hasPreview\": true\n }\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"sharedGaps\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"items\": 0\n }\n ],\n \"filableCount\": 0,\n \"pjudFilingEnabled\": true,\n \"editable\": true,\n \"generating\": true,\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create folder", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"internalCauseId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"parentFolderId\": \"\"\n }\n ]\n}" }, "description": "Create folder\n\nAuthentication: developer API key. Required scope: `internal-cases:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "create-folder" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/create-folder" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true,\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create internal case", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"rol\": \"C-1234-2024\",\n \"caratulado\": \"PÉREZ / BANCO\",\n \"initialStateSlug\": \"\u003cSTATE_SLUG\u003e\",\n \"orgId\": \"\u003cORG_ID\u003e\",\n \"teamIds\": [\n \"\u003cTEAM_ID\u003e\"\n ],\n \"tagSlugs\": [],\n \"assignedUserIds\": []\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "create-internal-case" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/create-internal-case" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true,\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create time entry", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"internalCauseId\": \"\",\n \"entryDate\": \"\",\n \"minutes\": 0,\n \"description\": \"\",\n \"billable\": false,\n \"hourlyRate\": 0,\n \"userId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "create-time-entry" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/create-time-entry" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete causa assignment", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete causa assignment\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cause-assignments", "mutations", "delete-cause-assignment" ], "raw": "{{baseUrl}}/api/actions/cause-assignments/mutations/delete-cause-assignment" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete causa assignments for user", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\",\n \"userId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cause-assignments", "mutations", "delete-cause-assignments-for-user" ], "raw": "{{baseUrl}}/api/actions/cause-assignments/mutations/delete-cause-assignments-for-user" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete cost entry", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003centryID\u003e\"\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "delete-cost-entry" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/delete-cost-entry" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete internal case", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\"\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "delete-internal-case" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/delete-internal-case" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete time entry", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003centryID\u003e\"\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "delete-time-entry" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/delete-time-entry" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Execute expediente", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"operation\": \"\",\n \"id\": \"\",\n \"orgId\": \"\",\n \"name\": \"\",\n \"reference\": \"\",\n \"clientName\": \"\",\n \"description\": \"\",\n \"teamIds\": [],\n \"assignedUserIds\": [],\n \"creationKey\": \"\",\n \"causes\": [],\n \"cause\": {},\n \"relatedCauseId\": \"\",\n \"folderId\": \"\",\n \"documentId\": \"\",\n \"uploadKey\": \"\",\n \"dataBase64\": \"\",\n \"mimeType\": \"\",\n \"preserveDocuments\": false\n }\n ]\n}" }, "description": "Execute expediente\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "expedientes", "workspace", "execute-expediente" ], "raw": "{{baseUrl}}/api/actions/expedientes/workspace/execute-expediente" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true,\n \"id\": \"string\",\n \"url\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Queue case activity export", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"section\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"hideLiquidacionCausas\": false,\n \"hideReviewed\": false,\n \"page\": 0,\n \"per_page\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-activity", "mutations", "queue-case-activity-export" ], "raw": "{{baseUrl}}/api/actions/case-activity/mutations/queue-case-activity-export" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"jobId\": \"string\",\n \"alreadyQueued\": true\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save internal case settings", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"states\": [],\n \"tags\": [],\n \"fields\": []\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "save-internal-case-settings" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/save-internal-case-settings" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set batch item excluded", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"batchId\": \"\",\n \"itemId\": \"\",\n \"excluded\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "writings", "mutations", "set-batch-item-excluded" ], "raw": "{{baseUrl}}/api/actions/writings/mutations/set-batch-item-excluded" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"batch\": {\n \"id\": \"string\",\n \"source\": \"plantilla\",\n \"plantillaId\": \"string\",\n \"tipo\": \"string\",\n \"titulo\": \"string\",\n \"state\": \"DRAFTING\",\n \"sharedValues\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"createdById\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"confirmedById\": \"string\",\n \"confirmedAt\": \"2026-01-31T12:00:00Z\",\n \"requiereIA\": true,\n \"canal\": \"string\"\n },\n \"items\": [\n {\n \"id\": \"string\",\n \"causaRef\": \"string\",\n \"causaKind\": \"bc\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"caratula\": \"string\",\n \"escritoKind\": \"generic\",\n \"escritoRef\": \"string\",\n \"state\": \"PENDING\",\n \"error\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"shared\": true\n }\n ],\n \"answers\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"channels\": [\n {\n \"canal\": \"bc\",\n \"jobId\": \"string\",\n \"state\": \"string\",\n \"status\": \"pending\",\n \"error\": \"string\",\n \"folio\": \"string\",\n \"numeroIngreso\": \"string\",\n \"enabled\": true\n }\n ],\n \"filable\": true,\n \"hasPreview\": true\n }\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"sharedGaps\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"items\": 0\n }\n ],\n \"filableCount\": 0,\n \"pjudFilingEnabled\": true,\n \"editable\": true,\n \"generating\": true,\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set case activity reviewed", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"section\": \"\",\n \"id\": \"\",\n \"reviewed\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-activity", "mutations", "set-case-activity-reviewed" ], "raw": "{{baseUrl}}/api/actions/case-activity/mutations/set-case-activity-reviewed" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"section\": \"string\",\n \"id\": \"string\",\n \"reviewed\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Update internal case", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"caratulado\": \"\",\n \"description\": \"\",\n \"fechaDeIng\": \"\",\n \"region\": \"\",\n \"tagSlugs\": [],\n \"jpl\": \"\",\n \"metadata\": [],\n \"teamIds\": [],\n \"assignedUserIds\": [],\n \"archived\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "internal-cases", "mutations", "update-internal-case" ], "raw": "{{baseUrl}}/api/actions/internal-cases/mutations/update-internal-case" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"internal-cases:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Expedientes and activity" }, { "item": [ { "name": "Get one ruling", "request": { "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.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "case-law", "document" ], "query": [ { "description": "Case-law identifier.", "disabled": false, "key": "jurisId", "value": "" }, { "description": "Collection the ruling belongs to (list items carry it). PJUD reuses ids across buscadores; required when the id is ambiguous (409).", "disabled": true, "key": "buscador", "value": "" }, { "description": "Include raw HTML fields.", "disabled": true, "key": "includeHtml", "value": "" } ], "raw": "{{baseUrl}}/api/case-law/document?jurisId=" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"jurisId\": \"string\",\n \"buscador\": \"CORTE_SUPREMA\",\n \"caratulado\": \"string\",\n \"caratuladoAnon\": \"string\",\n \"corte\": \"string\",\n \"sala\": \"string\",\n \"rolEraApe\": \"string\",\n \"resultadoRecurso\": \"string\",\n \"fecSentenciaSup\": \"2026-01-31T12:00:00Z\",\n \"urlAccesoSentencia\": \"string\",\n \"urlCortaAccesoSentencia\": \"string\",\n \"citaBibliografica\": \"string\",\n \"privilegio\": \"string\",\n \"titulo\": \"string\",\n \"tribunal\": \"string\",\n \"rol\": \"string\",\n \"materia\": \"string\",\n \"origen\": \"string\",\n \"resultado\": \"string\",\n \"descriptores\": [\n \"string\"\n ],\n \"normas\": [\n \"string\"\n ],\n \"ministros\": [\n \"string\"\n ],\n \"redactor\": \"string\",\n \"textoSentenciaText\": \"string\",\n \"textoSentenciaAnonText\": \"string\",\n \"textoSentenciaHtml\": \"string\",\n \"textoSentenciaAnonHtml\": \"string\",\n \"textoSentenciaPreview\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List case-law rulings", "request": { "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.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "case-law", "documents" ], "query": [ { "description": "Source.", "disabled": true, "key": "buscador", "value": "" }, { "description": "Free-text filter.", "disabled": true, "key": "q", "value": "" }, { "description": "Start date, YYYY-MM-DD.", "disabled": true, "key": "dateFrom", "value": "" }, { "description": "End date, YYYY-MM-DD.", "disabled": true, "key": "dateTo", "value": "" }, { "description": "Page number (default 1).", "disabled": true, "key": "page", "value": "" }, { "description": "Rows per page (max 100).", "disabled": true, "key": "pageSize", "value": "" }, { "description": "Include the total count (slower). Text-search totals stop at 1000: the response then carries totalCapped=true and totalPages 0.", "disabled": true, "key": "includeTotal", "value": "" }, { "description": "Opaque cursor from a previous page's nextCursor.", "disabled": true, "key": "cursor", "value": "" } ], "raw": "{{baseUrl}}/api/case-law/documents" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"page\": 0,\n \"pageSize\": 0,\n \"total\": 0,\n \"totalPages\": 0,\n \"totalCapped\": true,\n \"items\": [\n {\n \"jurisId\": \"string\",\n \"buscador\": \"CORTE_SUPREMA\",\n \"caratulado\": \"string\",\n \"caratuladoAnon\": \"string\",\n \"corte\": \"string\",\n \"sala\": \"string\",\n \"rolEraApe\": \"string\",\n \"resultadoRecurso\": \"string\",\n \"fecSentenciaSup\": \"2026-01-31T12:00:00Z\",\n \"urlAccesoSentencia\": \"string\",\n \"urlCortaAccesoSentencia\": \"string\",\n \"citaBibliografica\": \"string\",\n \"privilegio\": \"string\",\n \"snippet\": \"string\",\n \"titulo\": \"string\",\n \"tribunal\": \"string\",\n \"rol\": \"string\",\n \"materia\": \"string\",\n \"origen\": \"string\",\n \"resultado\": \"string\",\n \"descriptores\": [\n \"string\"\n ]\n }\n ],\n \"nextCursor\": \"string\",\n \"hasMore\": true\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Case law" }, { "item": [ { "name": "Get tta causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get tta causa\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tta", "tracking", "get-tta-cause" ], "raw": "{{baseUrl}}/api/actions/tta/tracking/get-tta-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causa\": {\n \"id\": \"string\",\n \"rit\": \"string\",\n \"ruc\": \"string\",\n \"caratula\": \"string\",\n \"tribunal\": \"string\",\n \"procedimiento\": \"string\",\n \"etapa\": \"string\",\n \"estado\": \"string\",\n \"montoCuantia\": \"string\"\n },\n \"actuaciones\": [\n {\n \"id\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"descripcion\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get tta status", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Get tta status\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tta", "tracking", "get-tta-status" ], "raw": "{{baseUrl}}/api/actions/tta/tracking/get-tta-status" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"status\": \"string\",\n \"lastOkAt\": \"2026-01-31T12:00:00Z\",\n \"lastAttemptAt\": \"2026-01-31T12:00:00Z\",\n \"lastError\": \"string\",\n \"failingSince\": \"2026-01-31T12:00:00Z\",\n \"hasCausas\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List tta causas", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "List tta causas\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tta", "tracking", "list-tta-causes" ], "raw": "{{baseUrl}}/api/actions/tta/tracking/list-tta-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"id\": \"string\",\n \"source\": \"string\",\n \"rit\": \"string\",\n \"ruc\": \"string\",\n \"caratula\": \"string\",\n \"tribunal\": \"string\",\n \"procedimiento\": \"string\",\n \"etapa\": \"string\",\n \"estado\": \"string\",\n \"montoCuantia\": \"string\",\n \"fechaPresentacion\": \"2026-01-31T12:00:00Z\",\n \"lastSyncAt\": \"2026-01-31T12:00:00Z\",\n \"actuaciones\": 0,\n \"lastActuacionAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"state\": {\n \"status\": \"string\",\n \"lastOkAt\": \"2026-01-31T12:00:00Z\",\n \"lastAttemptAt\": \"2026-01-31T12:00:00Z\",\n \"lastError\": \"string\",\n \"failingSince\": \"2026-01-31T12:00:00Z\",\n \"hasCausas\": true\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Import tta excel", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"filename\": \"\",\n \"contentBase64\": \"\"\n }\n ]\n}" }, "description": "Import tta excel\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tta", "tracking", "import-tta-excel" ], "raw": "{{baseUrl}}/api/actions/tta/tracking/import-tta-excel" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"imported\": 0,\n \"state\": {\n \"status\": \"string\",\n \"lastOkAt\": \"2026-01-31T12:00:00Z\",\n \"lastAttemptAt\": \"2026-01-31T12:00:00Z\",\n \"lastError\": \"string\",\n \"failingSince\": \"2026-01-31T12:00:00Z\",\n \"hasCausas\": true\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Remove tta causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Remove tta causa\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tta", "tracking", "remove-tta-cause" ], "raw": "{{baseUrl}}/api/actions/tta/tracking/remove-tta-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Sync tta", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Sync tta\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tta", "tracking", "sync-tta" ], "raw": "{{baseUrl}}/api/actions/tta/tracking/sync-tta" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"state\": {\n \"status\": \"string\",\n \"lastOkAt\": \"2026-01-31T12:00:00Z\",\n \"lastAttemptAt\": \"2026-01-31T12:00:00Z\",\n \"lastError\": \"string\",\n \"failingSince\": \"2026-01-31T12:00:00Z\",\n \"hasCausas\": true\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Tax and Customs Courts (TTA)" }, { "item": [ { "name": "Get boletin concursal movements section", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"section\": \"\",\n \"page\": 0,\n \"per_page\": 0,\n \"from\": \"\",\n \"to\": \"\",\n \"hideLiquidador\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "boletin-concursal-movements", "queries", "get-boletin-concursal-movements-section" ], "raw": "{{baseUrl}}/api/actions/boletin-concursal-movements/queries/get-boletin-concursal-movements-section" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"section\": {\n \"slug\": \"string\",\n \"total\": 0,\n \"pageCount\": 0,\n \"rows\": [\n {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"rol\": \"string\",\n \"causaId\": \"string\",\n \"procedimientoNombre\": \"string\",\n \"nombre\": \"string\",\n \"numero\": \"string\",\n \"materia\": \"string\",\n \"estado\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"documentoUrl\": \"string\",\n \"documentoStoragePath\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get boletin concursal movements section counts", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"from\": \"\",\n \"to\": \"\",\n \"hideLiquidador\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "boletin-concursal-movements", "queries", "get-boletin-concursal-movements-section-counts" ], "raw": "{{baseUrl}}/api/actions/boletin-concursal-movements/queries/get-boletin-concursal-movements-section-counts" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"counts\": {\n \"publicacion\": 0,\n \"etapa\": 0,\n \"actuacion\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get boletin tracking detail", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaBcId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "boletin-tracking", "get-boletin-tracking-detail" ], "raw": "{{baseUrl}}/api/actions/boletin-tracking/get-boletin-tracking-detail" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"procedure\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get boletin upload queue", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"page\": 0,\n \"per_page\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "boletin-queue", "queries", "get-boletin-upload-queue" ], "raw": "{{baseUrl}}/api/actions/boletin-queue/queries/get-boletin-upload-queue" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"id\": \"string\",\n \"causaId\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"sourceId\": \"string\",\n \"publicationType\": \"string\",\n \"state\": \"string\",\n \"attempts\": 0,\n \"errorMessage\": \"string\",\n \"portalPubId\": \"string\",\n \"createdAt\": \"string\",\n \"completedAt\": \"string\"\n }\n ],\n \"total\": 0,\n \"pageCount\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List boletin tracking", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaBcId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"available\": false,\n \"page\": 0\n }\n ]\n}" }, "description": "List boletin tracking\n\nAuthentication: developer API key. Required scope: `causas:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "boletin-tracking", "list-boletin-tracking" ], "raw": "{{baseUrl}}/api/actions/boletin-tracking/list-boletin-tracking" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"causaBcId\": \"string\",\n \"source\": \"PUBLIC\",\n \"documentId\": \"string\",\n \"nombre\": \"string\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"estado\": \"string\",\n \"trackingId\": \"string\",\n \"active\": true,\n \"assignedUserIds\": [\n \"string\"\n ],\n \"assignedTeamIds\": [\n \"string\"\n ],\n \"lastViewedAt\": \"2026-01-31T12:00:00Z\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"deudorRut\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"ultimaGestion\": \"string\",\n \"fechaGestion\": \"2026-01-31T12:00:00Z\",\n \"cantidadGestiones\": 0,\n \"movementCount\": true\n }\n ],\n \"page\": 0,\n \"pageSize\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete boletin publication upload", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\",\n \"sourceType\": \"\",\n \"sourceId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-activity", "mutations", "delete-boletin-publication-upload" ], "raw": "{{baseUrl}}/api/actions/case-activity/mutations/delete-boletin-publication-upload" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"success\": true\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Queue boletin publication upload", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\",\n \"sourceType\": \"\",\n \"sourceId\": \"\",\n \"tipoPublicacion\": \"\",\n \"comentario\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-activity", "mutations", "queue-boletin-publication-upload" ], "raw": "{{baseUrl}}/api/actions/case-activity/mutations/queue-boletin-publication-upload" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"jobId\": \"string\",\n \"alreadyQueued\": true\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set boletin tracking", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaBcId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"available\": false,\n \"page\": 0\n }\n ]\n}" }, "description": "Set boletin tracking\n\nAuthentication: developer API key. Required scope: `causas:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "boletin-tracking", "set-boletin-tracking" ], "raw": "{{baseUrl}}/api/actions/boletin-tracking/set-boletin-tracking" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"trackingId\": \"string\",\n \"active\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upload boletin publication", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"causaId\": \"\u003cCAUSA_ID\u003e\",\n \"docResolucion\": \"@/path/to/file.pdf\",\n \"sourceId\": \"\u003cSOURCE_ID\u003e\",\n \"sourceType\": \"\u003cSOURCE_TYPE\u003e\",\n \"tipoPublicacion\": \"\u003cTIPO_PUBLICACION\u003e\"\n}" }, "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`.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "case-activity", "mutations", "upload-boletin-publication" ], "raw": "{{baseUrl}}/api/actions/case-activity/mutations/upload-boletin-publication" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"status\": \"string\",\n \"verified\": true,\n \"publicationType\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Insolvency Bulletin" }, { "item": [ { "name": "Detail", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Detail\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tc", "queries", "detail" ], "raw": "{{baseUrl}}/api/actions/tc/queries/detail" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"case\": {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"active\": true,\n \"status\": \"string\",\n \"lastError\": \"string\",\n \"filedAt\": \"2026-01-31T12:00:00Z\",\n \"lastFetchedAt\": \"2026-01-31T12:00:00Z\",\n \"lastViewedAt\": \"2026-01-31T12:00:00Z\",\n \"snapshot\": {\n \"externalId\": 0,\n \"orderId\": 0,\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"filedAt\": \"2026-01-31T12:00:00Z\",\n \"warnings\": [\n \"string\"\n ],\n \"notebooks\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"stage\": \"string\",\n \"status\": \"string\"\n }\n ],\n \"parties\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"movements\": [\n {\n \"id\": \"string\",\n \"notebookId\": \"string\",\n \"type\": \"string\",\n \"reference\": \"string\",\n \"date\": \"string\",\n \"stage\": \"string\",\n \"documentId\": \"string\",\n \"reserved\": true,\n \"firstSeenAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"documents\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"notebookId\": \"string\",\n \"availability\": \"UNKNOWN\"\n }\n ]\n },\n \"movements\": [\n {\n \"id\": \"string\",\n \"notebookId\": \"string\",\n \"type\": \"string\",\n \"reference\": \"string\",\n \"date\": \"string\",\n \"stage\": \"string\",\n \"documentId\": \"string\",\n \"reserved\": true,\n \"firstSeenAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"documents\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"notebookId\": \"string\",\n \"availability\": \"UNKNOWN\"\n }\n ],\n \"parties\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"role\": \"string\"\n }\n ]\n },\n \"canArchive\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Document\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tc", "queries", "document" ], "raw": "{{baseUrl}}/api/actions/tc/queries/document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"name\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "List\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tc", "queries", "list" ], "raw": "{{baseUrl}}/api/actions/tc/queries/list" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"active\": true,\n \"status\": \"string\",\n \"lastError\": \"string\",\n \"lastFetchedAt\": \"2026-01-31T12:00:00Z\",\n \"lastViewedAt\": \"2026-01-31T12:00:00Z\",\n \"movementCount\": 0,\n \"newCount\": 0\n }\n ],\n \"total\": 0,\n \"page\": 0,\n \"pageSize\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Search", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Search\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tc", "queries", "search" ], "raw": "{{baseUrl}}/api/actions/tc/queries/search" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"externalId\": 0,\n \"orderId\": 0,\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"procedureId\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Mark reviewed", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Mark reviewed\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tc", "mutations", "mark-reviewed" ], "raw": "{{baseUrl}}/api/actions/tc/mutations/mark-reviewed" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"reviewed\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Refresh", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Refresh\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tc", "mutations", "refresh" ], "raw": "{{baseUrl}}/api/actions/tc/mutations/refresh" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"status\": \"AVAILABLE\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set active", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Set active\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tc", "mutations", "set-active" ], "raw": "{{baseUrl}}/api/actions/tc/mutations/set-active" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"active\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upsert", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Upsert\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tc", "mutations", "upsert" ], "raw": "{{baseUrl}}/api/actions/tc/mutations/upsert" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"status\": \"AVAILABLE\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Constitutional Court" }, { "item": [ { "name": "Detail", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Detail\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tcp", "queries", "detail" ], "raw": "{{baseUrl}}/api/actions/tcp/queries/detail" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"case\": {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"active\": true,\n \"status\": \"string\",\n \"lastError\": \"string\",\n \"filedAt\": \"2026-01-31T12:00:00Z\",\n \"lastFetchedAt\": \"2026-01-31T12:00:00Z\",\n \"lastViewedAt\": \"2026-01-31T12:00:00Z\",\n \"snapshot\": {\n \"externalId\": 0,\n \"orderId\": 0,\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"filedAt\": \"2026-01-31T12:00:00Z\",\n \"warnings\": [\n \"string\"\n ],\n \"notebooks\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"stage\": \"string\",\n \"status\": \"string\"\n }\n ],\n \"parties\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"movements\": [\n {\n \"id\": \"string\",\n \"notebookId\": \"string\",\n \"type\": \"string\",\n \"reference\": \"string\",\n \"date\": \"string\",\n \"stage\": \"string\",\n \"documentId\": \"string\",\n \"reserved\": true,\n \"firstSeenAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"documents\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"notebookId\": \"string\",\n \"availability\": \"UNKNOWN\"\n }\n ]\n },\n \"movements\": [\n {\n \"id\": \"string\",\n \"notebookId\": \"string\",\n \"type\": \"string\",\n \"reference\": \"string\",\n \"date\": \"string\",\n \"stage\": \"string\",\n \"documentId\": \"string\",\n \"reserved\": true,\n \"firstSeenAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"documents\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"notebookId\": \"string\",\n \"availability\": \"UNKNOWN\"\n }\n ],\n \"parties\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"role\": \"string\"\n }\n ]\n },\n \"canArchive\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Document\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tcp", "queries", "document" ], "raw": "{{baseUrl}}/api/actions/tcp/queries/document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"name\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "List\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tcp", "queries", "list" ], "raw": "{{baseUrl}}/api/actions/tcp/queries/list" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"active\": true,\n \"status\": \"string\",\n \"lastError\": \"string\",\n \"lastFetchedAt\": \"2026-01-31T12:00:00Z\",\n \"lastViewedAt\": \"2026-01-31T12:00:00Z\",\n \"movementCount\": 0,\n \"newCount\": 0\n }\n ],\n \"total\": 0,\n \"page\": 0,\n \"pageSize\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Search", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Search\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tcp", "queries", "search" ], "raw": "{{baseUrl}}/api/actions/tcp/queries/search" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"externalId\": 0,\n \"orderId\": 0,\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"procedureId\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Mark reviewed", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Mark reviewed\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tcp", "mutations", "mark-reviewed" ], "raw": "{{baseUrl}}/api/actions/tcp/mutations/mark-reviewed" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"reviewed\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Refresh", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Refresh\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tcp", "mutations", "refresh" ], "raw": "{{baseUrl}}/api/actions/tcp/mutations/refresh" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"status\": \"AVAILABLE\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set active", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Set active\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tcp", "mutations", "set-active" ], "raw": "{{baseUrl}}/api/actions/tcp/mutations/set-active" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"active\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upsert", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"rol\": \"\",\n \"documentId\": \"\",\n \"active\": false,\n \"search\": \"\",\n \"page\": 0,\n \"lastFetchedAt\": \"\"\n }\n ]\n}" }, "description": "Upsert\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tcp", "mutations", "upsert" ], "raw": "{{baseUrl}}/api/actions/tcp/mutations/upsert" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"status\": \"AVAILABLE\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Public Procurement Court" }, { "item": [ { "name": "Search RUT records", "request": { "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.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "ruts", "search" ], "raw": "{{baseUrl}}/api/ruts/search" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"count\": 0,\n \"limit\": 0,\n \"items\": [\n {\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"sexo\": \"string\",\n \"domicilioElectoral\": \"string\",\n \"circunscripcion\": \"string\",\n \"mesa\": \"string\",\n \"emails\": [\n \"string\"\n ],\n \"phones\": [\n \"string\"\n ],\n \"source\": \"string\",\n \"cacheState\": \"string\",\n \"lastSyncedAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "RUTs" }, { "item": [ { "name": "Analyze liquidacion workspace", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Analyze liquidacion workspace\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "analyze-liquidacion-workspace" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/analyze-liquidacion-workspace" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"state\": \"QUEUED\",\n \"message\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Export liquidaciones review", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Export liquidaciones review\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "export-liquidations-review" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/export-liquidations-review" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"fileName\": \"string\",\n \"mimeType\": \"string\",\n \"base64\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get honorario30 UF document url", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"procedimientoId\": \"\",\n \"path\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "get-honorario30-ufdocument-url" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/get-honorario30-ufdocument-url" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"previewUrl\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get honorario30 UF documentos", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"procedimientoId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "get-honorario30-ufdocumentos" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/get-honorario30-ufdocumentos" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"documentos\": [\n {\n \"id\": \"string\",\n \"nombre\": \"string\",\n \"ingreso\": \"string\",\n \"slot\": \"string\",\n \"slotLabel\": \"string\",\n \"path\": \"string\",\n \"read\": true,\n \"problems\": [\n \"string\"\n ]\n }\n ],\n \"faltantes\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get honorarios30 UF", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Get honorarios30 UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "get-honorarios30-uf" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/get-honorarios30-uf" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"procedimientoId\": \"string\",\n \"cbcId\": \"string\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"deudor\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"estadoProcedimiento\": \"string\",\n \"origen\": \"string\",\n \"estadoFlujo\": \"string\",\n \"acciones\": {\n \"\u003ckey\u003e\": true\n },\n \"historia\": {},\n \"seenAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"syncedAt\": \"2026-01-31T12:00:00Z\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidacion cierre", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"source\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidacion-cierre" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidacion-cierre" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"checklist\": {\n \"impedimentos\": [\n {\n \"id\": \"string\",\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"severity\": \"string\",\n \"explanation\": \"string\",\n \"reviewedState\": \"string\",\n \"effectiveState\": \"string\",\n \"taskId\": \"string\",\n \"order\": 0,\n \"phase\": \"string\",\n \"legalBasis\": \"string\",\n \"plazo\": \"string\",\n \"closingRole\": \"string\",\n \"nextAction\": \"string\",\n \"actor\": \"string\",\n \"evidence\": {\n \"source\": \"L\",\n \"items\": [\n \"string\"\n ],\n \"references\": [\n {\n \"id\": \"string\",\n \"source\": \"publications\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"evidenceCandidate\": true\n }\n ]\n },\n \"reviewNote\": \"string\",\n \"reviewedAt\": \"2026-01-31T12:00:00Z\",\n \"appliesToFamily\": true,\n \"task\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"dueDate\": \"string\",\n \"findingId\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ]\n }\n }\n ],\n \"hitosPendientes\": [\n {\n \"id\": \"string\",\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"severity\": \"string\",\n \"explanation\": \"string\",\n \"reviewedState\": \"string\",\n \"effectiveState\": \"string\",\n \"taskId\": \"string\",\n \"order\": 0,\n \"phase\": \"string\",\n \"legalBasis\": \"string\",\n \"plazo\": \"string\",\n \"closingRole\": \"string\",\n \"nextAction\": \"string\",\n \"actor\": \"string\",\n \"evidence\": {\n \"source\": \"L\",\n \"items\": [\n \"string\"\n ],\n \"references\": [\n {\n \"id\": \"string\",\n \"source\": \"publications\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"evidenceCandidate\": true\n }\n ]\n },\n \"reviewNote\": \"string\",\n \"reviewedAt\": \"2026-01-31T12:00:00Z\",\n \"appliesToFamily\": true,\n \"task\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"dueDate\": \"string\",\n \"findingId\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ]\n }\n }\n ],\n \"certificaciones\": [\n {\n \"id\": \"string\",\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"severity\": \"string\",\n \"explanation\": \"string\",\n \"reviewedState\": \"string\",\n \"effectiveState\": \"string\",\n \"taskId\": \"string\",\n \"order\": 0,\n \"phase\": \"string\",\n \"legalBasis\": \"string\",\n \"plazo\": \"string\",\n \"closingRole\": \"string\",\n \"nextAction\": \"string\",\n \"actor\": \"string\",\n \"evidence\": {\n \"source\": \"L\",\n \"items\": [\n \"string\"\n ],\n \"references\": [\n {\n \"id\": \"string\",\n \"source\": \"publications\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"evidenceCandidate\": true\n }\n ]\n },\n \"reviewNote\": \"string\",\n \"reviewedAt\": \"2026-01-31T12:00:00Z\",\n \"appliesToFamily\": true,\n \"task\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"dueDate\": \"string\",\n \"findingId\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ]\n }\n }\n ],\n \"completados\": [\n {\n \"id\": \"string\",\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"severity\": \"string\",\n \"explanation\": \"string\",\n \"reviewedState\": \"string\",\n \"effectiveState\": \"string\",\n \"taskId\": \"string\",\n \"order\": 0,\n \"phase\": \"string\",\n \"legalBasis\": \"string\",\n \"plazo\": \"string\",\n \"closingRole\": \"string\",\n \"nextAction\": \"string\",\n \"actor\": \"string\",\n \"evidence\": {\n \"source\": \"L\",\n \"items\": [\n \"string\"\n ],\n \"references\": [\n {\n \"id\": \"string\",\n \"source\": \"publications\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"evidenceCandidate\": true\n }\n ]\n },\n \"reviewNote\": \"string\",\n \"reviewedAt\": \"2026-01-31T12:00:00Z\",\n \"appliesToFamily\": true,\n \"task\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"dueDate\": \"string\",\n \"findingId\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ]\n }\n }\n ],\n \"noAplica\": [\n {\n \"id\": \"string\",\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"severity\": \"string\",\n \"explanation\": \"string\",\n \"reviewedState\": \"string\",\n \"effectiveState\": \"string\",\n \"taskId\": \"string\",\n \"order\": 0,\n \"phase\": \"string\",\n \"legalBasis\": \"string\",\n \"plazo\": \"string\",\n \"closingRole\": \"string\",\n \"nextAction\": \"string\",\n \"actor\": \"string\",\n \"evidence\": {\n \"source\": \"L\",\n \"items\": [\n \"string\"\n ],\n \"references\": [\n {\n \"id\": \"string\",\n \"source\": \"publications\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"evidenceCandidate\": true\n }\n ]\n },\n \"reviewNote\": \"string\",\n \"reviewedAt\": \"2026-01-31T12:00:00Z\",\n \"appliesToFamily\": true,\n \"task\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"dueDate\": \"string\",\n \"findingId\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ]\n }\n }\n ],\n \"futuros\": [\n {\n \"id\": \"string\",\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"severity\": \"string\",\n \"explanation\": \"string\",\n \"reviewedState\": \"string\",\n \"effectiveState\": \"string\",\n \"taskId\": \"string\",\n \"order\": 0,\n \"phase\": \"string\",\n \"legalBasis\": \"string\",\n \"plazo\": \"string\",\n \"closingRole\": \"string\",\n \"nextAction\": \"string\",\n \"actor\": \"string\",\n \"evidence\": {\n \"source\": \"L\",\n \"items\": [\n \"string\"\n ],\n \"references\": [\n {\n \"id\": \"string\",\n \"source\": \"publications\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"evidenceCandidate\": true\n }\n ]\n },\n \"reviewNote\": \"string\",\n \"reviewedAt\": \"2026-01-31T12:00:00Z\",\n \"appliesToFamily\": true,\n \"task\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"dueDate\": \"string\",\n \"findingId\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ]\n }\n }\n ],\n \"total\": 0,\n \"covered\": 0\n },\n \"familia\": \"string\",\n \"nextStep\": {\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"phase\": \"string\",\n \"legalBasis\": \"string\",\n \"plazo\": \"string\",\n \"action\": \"string\",\n \"actor\": \"string\"\n },\n \"plazos\": [\n {\n \"key\": \"string\",\n \"title\": \"string\",\n \"legalBasis\": \"string\",\n \"note\": \"string\",\n \"baseEvent\": \"string\",\n \"baseDate\": \"2026-01-31T12:00:00Z\",\n \"dueDate\": \"2026-01-31T12:00:00Z\",\n \"days\": 0,\n \"businessDays\": true,\n \"dayRule\": \"string\",\n \"dayRuleLabel\": \"string\",\n \"approx\": true,\n \"status\": \"string\",\n \"doneEvent\": \"string\",\n \"doneDate\": \"2026-01-31T12:00:00Z\",\n \"daysLeft\": 0\n }\n ],\n \"bienesConciliacion\": {\n \"complete\": true,\n \"pendingBienes\": 0,\n \"pendingEvents\": 0,\n \"pendingRendiciones\": 0,\n \"pendingDocs\": 0,\n \"reasons\": [\n \"string\"\n ]\n },\n \"cuentaFinalPreparacion\": {\n \"reference\": \"string\",\n \"state\": \"PREPARACION_PARCIAL\",\n \"incomeAccounts\": [\n {\n \"code\": \"string\",\n \"label\": \"string\",\n \"amount\": 0\n }\n ],\n \"expenseAccounts\": [\n {\n \"code\": \"string\",\n \"label\": \"string\",\n \"amount\": 0\n }\n ],\n \"verifiedRenditions\": 0,\n \"pendingRenditions\": 0,\n \"nonCLPRenditions\": 0,\n \"publishedBalancedProvisionalPeriods\": 0,\n \"provisionalPeriods\": [\n \"string\"\n ],\n \"pendingProvisionalPeriods\": [\n \"string\"\n ],\n \"accountingWarnings\": [\n {\n \"code\": \"string\",\n \"label\": \"string\",\n \"provisionalAmount\": 0,\n \"renditionAmount\": 0,\n \"message\": \"string\"\n }\n ],\n \"knownFigures\": [\n {\n \"code\": \"string\",\n \"label\": \"string\",\n \"amount\": 0,\n \"currency\": \"string\",\n \"source\": \"string\"\n }\n ],\n \"requiredManualInputs\": [\n \"string\"\n ],\n \"amountsOmitted\": 0,\n \"warning\": \"string\"\n },\n \"cuentasFinalesMotivos\": [\n \"string\"\n ],\n \"cuentasFinalesHabilitadas\": true,\n \"adminStatus\": \"CERRADO\",\n \"ageApprox\": true,\n \"ageDays\": 0,\n \"dueSoonCount\": 0,\n \"fechaUltimaGestion\": \"string\",\n \"idleDays\": 0,\n \"idleSource\": \"documented_review\",\n \"lastSubstantiveAt\": \"string\",\n \"legalStatus\": \"TERMINO_FIRME\",\n \"nextDueDate\": \"string\",\n \"nextRequirement\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"action\": \"string\",\n \"state\": \"string\",\n \"dueDate\": \"string\"\n },\n \"nextTask\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"action\": \"string\",\n \"dueDate\": \"string\"\n },\n \"openTasks\": 0,\n \"overdueCount\": 0,\n \"pendingInstructions\": 0,\n \"reportVerdict\": \"BLOQUEADA\",\n \"rolYear\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidacion document url", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"path\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidacion-document-url" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidacion-document-url" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"previewUrl\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidacion portal form", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "get-liquidacion-portal-form" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/get-liquidacion-portal-form" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"preparedId\": \"string\",\n \"operationKey\": \"string\",\n \"title\": \"string\",\n \"fields\": [\n {\n \"name\": \"string\",\n \"label\": \"string\",\n \"type\": \"string\",\n \"value\": \"string\",\n \"required\": true,\n \"disabled\": true,\n \"multiple\": true,\n \"accept\": \"string\",\n \"options\": [\n {\n \"value\": \"string\",\n \"label\": \"string\",\n \"disabled\": true\n }\n ]\n }\n ],\n \"canSubmit\": true,\n \"unavailableReason\": \"string\",\n \"description\": \"string\",\n \"page\": {\n \"title\": \"string\",\n \"text\": \"string\",\n \"tables\": [\n {\n \"title\": \"string\",\n \"headers\": [\n \"string\"\n ],\n \"rows\": [\n []\n ]\n }\n ],\n \"links\": [\n {\n \"label\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n \"id\": \"string\",\n \"expiresAt\": \"2026-01-31T12:00:00Z\",\n \"submitLabel\": \"string\",\n \"storedAttachments\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\",\n \"size\": 0,\n \"sha256\": \"string\",\n \"url\": \"string\",\n \"available\": true,\n \"fieldName\": \"string\"\n }\n ],\n \"preselectStoredAttachments\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidacion workspace", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get liquidacion workspace\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "get-liquidacion-workspace" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/get-liquidacion-workspace" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"permissions\": {\n \"canSync\": true,\n \"canPrepare\": true,\n \"canSubmit\": true,\n \"canReview\": true,\n \"canAnalyze\": true\n },\n \"threads\": [\n {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"subject\": \"string\",\n \"state\": \"RECEIVED\",\n \"lastResponseAt\": \"2026-01-31T12:00:00Z\",\n \"lastSubstantiveAt\": \"2026-01-31T12:00:00Z\",\n \"receivedAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"resourceId\": \"string\",\n \"canReply\": true,\n \"messages\": [\n {\n \"id\": \"string\",\n \"direction\": \"string\",\n \"subject\": \"string\",\n \"body\": \"string\",\n \"sender\": \"string\",\n \"date\": \"2026-01-31T12:00:00Z\",\n \"state\": \"string\",\n \"attachments\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\",\n \"size\": 0,\n \"sha256\": \"string\",\n \"url\": \"string\",\n \"available\": true,\n \"fieldName\": \"string\"\n }\n ]\n }\n ],\n \"requirements\": [\n {\n \"id\": \"string\",\n \"_id\": \"string\",\n \"orgId\": \"string\",\n \"cbcId\": \"string\",\n \"threadId\": \"string\",\n \"sourceKey\": \"string\",\n \"title\": \"string\",\n \"instruction\": \"string\",\n \"explanation\": \"string\",\n \"nextAction\": \"string\",\n \"legalBasis\": \"string\",\n \"proofDescription\": \"string\",\n \"dueDate\": \"string\",\n \"dueVerified\": true,\n \"dueDateEstimated\": true,\n \"state\": \"PENDING\",\n \"evidence\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"file\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\"\n },\n \"page\": 0,\n \"threadId\": \"string\",\n \"quote\": \"string\"\n }\n ],\n \"evidenceHash\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ],\n \"taskId\": \"string\",\n \"reviewNote\": \"string\",\n \"reviewedById\": \"string\",\n \"reviewedAt\": \"string\",\n \"reviewHistory\": [\n {\n \"state\": \"string\",\n \"note\": \"string\",\n \"evidenceIds\": [\n \"string\"\n ],\n \"userId\": \"string\",\n \"at\": \"2026-01-31T12:00:00Z\",\n \"instructionDueDate\": \"string\",\n \"confirmDeadline\": true\n }\n ],\n \"cAt\": \"string\",\n \"uAt\": \"string\"\n }\n ]\n }\n ],\n \"requirements\": [\n {\n \"id\": \"string\",\n \"_id\": \"string\",\n \"orgId\": \"string\",\n \"cbcId\": \"string\",\n \"threadId\": \"string\",\n \"sourceKey\": \"string\",\n \"title\": \"string\",\n \"instruction\": \"string\",\n \"explanation\": \"string\",\n \"nextAction\": \"string\",\n \"legalBasis\": \"string\",\n \"proofDescription\": \"string\",\n \"dueDate\": \"string\",\n \"dueVerified\": true,\n \"dueDateEstimated\": true,\n \"state\": \"PENDING\",\n \"evidence\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"file\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\"\n },\n \"page\": 0,\n \"threadId\": \"string\",\n \"quote\": \"string\"\n }\n ],\n \"evidenceHash\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ],\n \"taskId\": \"string\",\n \"reviewNote\": \"string\",\n \"reviewedById\": \"string\",\n \"reviewedAt\": \"string\",\n \"reviewHistory\": [\n {\n \"state\": \"string\",\n \"note\": \"string\",\n \"evidenceIds\": [\n \"string\"\n ],\n \"userId\": \"string\",\n \"at\": \"2026-01-31T12:00:00Z\",\n \"instructionDueDate\": \"string\",\n \"confirmDeadline\": true\n }\n ],\n \"cAt\": \"string\",\n \"uAt\": \"string\"\n }\n ],\n \"operations\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"available\": true,\n \"unavailableReason\": \"string\"\n }\n ],\n \"records\": [\n {\n \"id\": \"string\",\n \"operationKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"archivedAt\": \"string\",\n \"page\": {\n \"title\": \"string\",\n \"text\": \"string\",\n \"tables\": [\n {\n \"title\": \"string\",\n \"headers\": [\n \"string\"\n ],\n \"rows\": [\n []\n ]\n }\n ],\n \"links\": [\n {\n \"label\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n \"detail\": \"string\",\n \"error\": \"string\",\n \"verified\": true,\n \"resourceId\": \"string\",\n \"canDelete\": true,\n \"canEdit\": true,\n \"attachments\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\",\n \"size\": 0,\n \"sha256\": \"string\",\n \"url\": \"string\",\n \"available\": true,\n \"fieldName\": \"string\"\n }\n ]\n }\n ],\n \"artifacts\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"kind\": \"string\",\n \"state\": \"string\",\n \"createdAt\": \"string\",\n \"body\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"contexto\": \"string\",\n \"sugerencia\": \"string\",\n \"opciones\": [\n {\n \"tipo\": \"liquidador\",\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"patrocinaEnCausa\": true,\n \"ultimoUso\": \"string\"\n }\n ],\n \"permiteNuevo\": true\n }\n ],\n \"files\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\"\n }\n ],\n \"error\": \"string\"\n }\n ],\n \"members\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"credentials\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"warnings\": [\n \"string\"\n ],\n \"causa\": {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"tribunal\": \"string\",\n \"source\": \"L\",\n \"documentId\": \"string\",\n \"causaId\": \"string\",\n \"tipoProcedimiento\": \"string\"\n },\n \"pagination\": {\n \"page\": 0,\n \"perPage\": 0,\n \"total\": 0,\n \"pageCount\": 0,\n \"search\": \"string\"\n },\n \"summary\": {\n \"pending\": 0,\n \"overdue\": 0,\n \"awaitingReply\": 0,\n \"completed\": 0\n },\n \"analysisSummary\": \"string\",\n \"threadAliases\": [\n {\n \"id\": \"string\",\n \"target\": \"string\"\n }\n ],\n \"analysisAt\": \"string\",\n \"analysisState\": \"string\",\n \"syncState\": \"string\",\n \"syncedAt\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidacion workspace document url", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "get-liquidacion-workspace-document-url" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/get-liquidacion-workspace-document-url" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"previewUrl\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidaciones canonical causas", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"page\": 0,\n \"per_page\": 0,\n \"search\": \"\",\n \"sort\": \"\",\n \"estado\": \"\",\n \"region\": \"\",\n \"tipoProc\": \"\",\n \"assignedToMe\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidations-canonical-causes" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidations-canonical-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"id\": \"string\",\n \"source\": \"L\",\n \"documentId\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"estado\": \"string\",\n \"deudorRut\": \"string\",\n \"tribunal\": \"string\",\n \"liquidador\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"region\": \"string\",\n \"ultimaGestion\": \"string\",\n \"fechaUltimaGestion\": \"string\",\n \"fecha\": \"string\",\n \"causaId\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"causaRol\": \"string\",\n \"groupId\": \"string\",\n \"preferredSource\": \"string\",\n \"sources\": [\n \"string\"\n ],\n \"primaryCausaIds\": [\n \"string\"\n ],\n \"sourceRecordIds\": [\n \"string\"\n ],\n \"relatedCausas\": [\n {\n \"id\": \"string\",\n \"relationType\": \"string\",\n \"causaId\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"tribunal\": \"string\",\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"identityKey\": \"string\"\n }\n ],\n \"assignedUserIds\": [\n \"string\"\n ],\n \"assignees\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\"\n }\n ]\n }\n ],\n \"pageCount\": 0,\n \"total\": 0,\n \"estados\": [\n \"string\"\n ],\n \"regiones\": [\n \"string\"\n ],\n \"tiposProcedimiento\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidaciones liquidador causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "One liquidador causa.\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidations-liquidador-cause" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidations-liquidador-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"publications\": [\n {\n \"id\": \"string\",\n \"nombre\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"estado\": \"string\",\n \"entePublicador\": \"string\",\n \"documentoUrl\": \"string\",\n \"documentoStoragePath\": \"string\",\n \"documentoSha256\": \"string\",\n \"documentoBytes\": 0,\n \"documentoMime\": \"string\",\n \"documentoDownloadedAt\": \"2026-01-31T12:00:00Z\",\n \"raw\": null,\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"note\": {\n \"id\": \"string\",\n \"text\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n }\n ],\n \"stages\": [\n {\n \"id\": \"string\",\n \"nombre\": \"string\",\n \"fechaEstimada\": \"2026-01-31T12:00:00Z\",\n \"estado\": \"string\",\n \"raw\": null,\n \"note\": {\n \"id\": \"string\",\n \"text\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n }\n ],\n \"actions\": [\n {\n \"id\": \"string\",\n \"numero\": \"string\",\n \"materia\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"estado\": \"string\",\n \"documentoUrl\": \"string\",\n \"documentoStoragePath\": \"string\",\n \"documentoSha256\": \"string\",\n \"documentoBytes\": 0,\n \"documentoMime\": \"string\",\n \"documentoDownloadedAt\": \"2026-01-31T12:00:00Z\",\n \"raw\": null,\n \"note\": {\n \"id\": \"string\",\n \"text\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n }\n ],\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"itemDesc\": \"string\",\n \"orgId\": \"string\",\n \"modifiedById\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"relatedCausas\": [\n {\n \"id\": \"string\",\n \"relationType\": \"string\",\n \"note\": \"string\",\n \"causaId\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"tribunal\": \"string\",\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"bitacoras\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"orgId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"bitacoraScope\": \"string\",\n \"source\": \"string\",\n \"findings\": [\n {\n \"id\": \"string\",\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"severity\": \"string\",\n \"explanation\": \"string\",\n \"reviewedState\": \"string\",\n \"taskId\": \"string\",\n \"reviewNote\": \"string\",\n \"reviewedAt\": \"2026-01-31T12:00:00Z\",\n \"evidence\": {\n \"source\": \"L\",\n \"items\": [\n \"string\"\n ],\n \"references\": [\n {\n \"id\": \"string\",\n \"source\": \"publications\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"evidenceCandidate\": true\n }\n ]\n }\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidaciones liquidador causas", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"page\": 0,\n \"per_page\": 0,\n \"search\": \"\",\n \"sort\": \"\",\n \"estado\": \"\",\n \"region\": \"\",\n \"tipoProc\": \"\",\n \"assignedToMe\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidations-liquidador-causes" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidations-liquidador-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"id\": \"string\",\n \"documentId\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"estado\": \"string\",\n \"deudorRut\": \"string\",\n \"tribunal\": \"string\",\n \"liquidador\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"region\": \"string\",\n \"rolSujeto\": \"string\",\n \"sujetoTitular\": \"string\",\n \"veedorAsociado\": \"string\",\n \"tieneMartilleros\": true,\n \"liquidadorAsociado\": true,\n \"glosas\": null,\n \"ultimaGestion\": \"string\",\n \"fechaUltimaGestion\": \"2026-01-31T12:00:00Z\",\n \"cantidadGestiones\": 0,\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"causaId\": \"string\",\n \"causaRol\": \"string\",\n \"relatedCausas\": [\n {\n \"id\": \"string\",\n \"relationType\": \"string\",\n \"causaId\": \"string\",\n \"rol\": \"string\"\n }\n ],\n \"assignedUserIds\": [\n \"string\"\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"pageCount\": 0,\n \"total\": 0,\n \"estados\": [\n \"string\"\n ],\n \"regiones\": [\n \"string\"\n ],\n \"tiposProcedimiento\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidaciones prioridad", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"portfolioReview\": false,\n \"source\": \"\",\n \"estado\": \"\",\n \"tipoProc\": \"\",\n \"region\": \"\",\n \"search\": \"\",\n \"assignedToMe\": false,\n \"verdict\": \"\",\n \"actionCategory\": \"\",\n \"drilldown\": \"\",\n \"hito\": \"\",\n \"sort\": \"\",\n \"page\": 0,\n \"per_page\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidations-prioridad" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidations-prioridad" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"id\": \"string\",\n \"source\": \"L\",\n \"documentId\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"estado\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"region\": \"string\",\n \"tribunal\": \"string\",\n \"liquidador\": \"string\",\n \"deudorRut\": \"string\",\n \"fecha\": \"string\",\n \"ultimaPublicacionRelevante\": \"string\",\n \"cantidadGestiones\": 0,\n \"publicationsCaptured\": 0,\n \"verdict\": \"BLOQUEADA\",\n \"blockers\": 0,\n \"pendingTotal\": 0,\n \"pendingHigh\": 0,\n \"pendingMedium\": 0,\n \"pendingKeys\": [\n \"string\"\n ],\n \"blockerKeys\": [\n \"string\"\n ],\n \"blockerTitles\": [\n \"string\"\n ],\n \"asignada\": true,\n \"stagesOverdue\": 0,\n \"assignedUserIds\": [\n \"string\"\n ],\n \"assignees\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\"\n }\n ],\n \"causaId\": \"string\",\n \"causaRol\": \"string\",\n \"findingsCount\": 0,\n \"analysisUpdatedAt\": \"string\",\n \"actionCategory\": \"RESPONDER_SUPERIR\",\n \"familia\": \"empresa\",\n \"nextStep\": {\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"phase\": \"string\",\n \"legalBasis\": \"string\",\n \"plazo\": \"string\",\n \"action\": \"string\",\n \"actor\": \"string\"\n },\n \"priorityReason\": \"string\",\n \"motivos\": [\n \"string\"\n ],\n \"rolYear\": 0,\n \"ageDays\": 0,\n \"ageApprox\": true,\n \"idleDays\": 0,\n \"fechaUltimaGestion\": \"string\",\n \"lastSubstantiveAt\": \"string\",\n \"idleSource\": \"documented_review\",\n \"legalStatus\": \"TERMINO_FIRME\",\n \"adminStatus\": \"CERRADO\",\n \"pendingInstructions\": 0,\n \"overdueCount\": 0,\n \"dueSoonCount\": 0,\n \"nextDueDate\": \"string\",\n \"nextRequirement\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"action\": \"string\",\n \"state\": \"string\",\n \"dueDate\": \"string\"\n },\n \"nextTask\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"action\": \"string\",\n \"dueDate\": \"string\"\n },\n \"openTasks\": 0\n }\n ],\n \"total\": 0,\n \"page\": 0,\n \"perPage\": 0,\n \"pageCount\": 0,\n \"sort\": \"string\",\n \"estado\": \"string\",\n \"verdictCounts\": {\n \"\u003ckey\u003e\": 0\n },\n \"hito\": \"string\",\n \"hitoTitle\": \"string\",\n \"analysisUpdatedAt\": \"string\",\n \"estados\": [\n \"string\"\n ],\n \"tiposProcedimiento\": [\n \"string\"\n ],\n \"regiones\": [\n \"string\"\n ],\n \"verdictOrder\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidaciones public causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidations-public-cause" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidations-public-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"publications\": [\n {\n \"id\": \"string\",\n \"nombre\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"estado\": \"string\",\n \"entePublicador\": \"string\",\n \"documentoUrl\": \"string\",\n \"documentoStoragePath\": \"string\",\n \"documentoSha256\": \"string\",\n \"documentoBytes\": 0,\n \"documentoMime\": \"string\",\n \"documentoDownloadedAt\": \"2026-01-31T12:00:00Z\",\n \"raw\": null,\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"note\": {\n \"id\": \"string\",\n \"text\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n }\n ],\n \"stages\": [\n {\n \"id\": \"string\",\n \"nombre\": \"string\",\n \"fechaEstimada\": \"2026-01-31T12:00:00Z\",\n \"estado\": \"string\",\n \"raw\": null,\n \"note\": {\n \"id\": \"string\",\n \"text\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n }\n ],\n \"actions\": [\n {\n \"id\": \"string\",\n \"numero\": \"string\",\n \"materia\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"estado\": \"string\",\n \"documentoUrl\": \"string\",\n \"documentoStoragePath\": \"string\",\n \"documentoSha256\": \"string\",\n \"documentoBytes\": 0,\n \"documentoMime\": \"string\",\n \"documentoDownloadedAt\": \"2026-01-31T12:00:00Z\",\n \"raw\": null,\n \"note\": {\n \"id\": \"string\",\n \"text\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n }\n ],\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"itemDesc\": \"string\",\n \"orgId\": \"string\",\n \"modifiedById\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"relatedCausas\": [\n {\n \"id\": \"string\",\n \"relationType\": \"string\",\n \"note\": \"string\",\n \"causaId\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"tribunal\": \"string\",\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"bitacoras\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"orgId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"bitacoraScope\": \"string\",\n \"source\": \"string\",\n \"findings\": [\n {\n \"id\": \"string\",\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"severity\": \"string\",\n \"explanation\": \"string\",\n \"reviewedState\": \"string\",\n \"taskId\": \"string\",\n \"reviewNote\": \"string\",\n \"reviewedAt\": \"2026-01-31T12:00:00Z\",\n \"evidence\": {\n \"source\": \"L\",\n \"items\": [\n \"string\"\n ],\n \"references\": [\n {\n \"id\": \"string\",\n \"source\": \"publications\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"evidenceCandidate\": true\n }\n ]\n }\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidaciones public causas", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"page\": 0,\n \"per_page\": 0,\n \"search\": \"\",\n \"sort\": \"\",\n \"estado\": \"\",\n \"region\": \"\",\n \"tipoProc\": \"\",\n \"assignedToMe\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidations-public-causes" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidations-public-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"id\": \"string\",\n \"documentId\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"estado\": \"string\",\n \"deudorRut\": \"string\",\n \"tribunal\": \"string\",\n \"liquidador\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"region\": \"string\",\n \"rolSujeto\": \"string\",\n \"sujetoTitular\": \"string\",\n \"veedorAsociado\": \"string\",\n \"tieneMartilleros\": true,\n \"liquidadorAsociado\": true,\n \"glosas\": null,\n \"ultimaGestion\": \"string\",\n \"fechaUltimaGestion\": \"2026-01-31T12:00:00Z\",\n \"cantidadGestiones\": 0,\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"causaId\": \"string\",\n \"causaRol\": \"string\",\n \"relatedCausas\": [\n {\n \"id\": \"string\",\n \"relationType\": \"string\",\n \"causaId\": \"string\",\n \"rol\": \"string\"\n }\n ],\n \"assignedUserIds\": [\n \"string\"\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"pageCount\": 0,\n \"total\": 0,\n \"estados\": [\n \"string\"\n ],\n \"regiones\": [\n \"string\"\n ],\n \"tiposProcedimiento\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidaciones reporte general", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"portfolioReview\": false,\n \"source\": \"\",\n \"estado\": \"\",\n \"tipoProc\": \"\",\n \"region\": \"\",\n \"search\": \"\",\n \"assignedToMe\": false,\n \"verdict\": \"\",\n \"actionCategory\": \"\",\n \"drilldown\": \"\",\n \"hito\": \"\",\n \"sort\": \"\",\n \"page\": 0,\n \"per_page\": 0\n }\n ]\n}" }, "description": "General liquidaciones report.\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidations-reporte-general" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidations-reporte-general" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"total\": 0,\n \"vigentes\": 0,\n \"terminadas\": 0,\n \"otras\": 0,\n \"bySource\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byEstado\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byTipo\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byTipoOtros\": 0,\n \"byFamilia\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byRegion\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byRegionOtros\": 0,\n \"byTribunal\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byTribunalOtros\": 0,\n \"byLiquidador\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byLiquidadorOtros\": 0,\n \"byRolYear\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"ageBuckets\": {\n \"order\": [\n \"string\"\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n }\n },\n \"idleBuckets\": {\n \"order\": [\n \"string\"\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n }\n },\n \"verdictOrder\": [\n \"string\"\n ],\n \"verdictCounts\": {\n \"\u003ckey\u003e\": 0\n },\n \"pendingByRule\": [\n {\n \"label\": \"string\",\n \"count\": 0,\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"phase\": \"string\",\n \"order\": 0,\n \"closingRole\": \"string\"\n }\n ],\n \"blockersByRule\": [\n {\n \"label\": \"string\",\n \"count\": 0,\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"phase\": \"string\",\n \"order\": 0,\n \"closingRole\": \"string\"\n }\n ],\n \"vigentesSinPublicaciones\": 0,\n \"vigentesSinAnalisis\": 0,\n \"vigentesAsignadas\": 0,\n \"vigentesSinAsignar\": 0,\n \"vigentesSinGestion90\": 0,\n \"vigentesSinGestion180\": 0,\n \"vigentesMas5Anios\": 0,\n \"vigentesEtapasVencidas\": 0,\n \"vigentesCasiCerradas\": 0,\n \"vencimientosVencidos\": 0,\n \"vencimientosProximos\": 0,\n \"instruccionesPendientes\": 0,\n \"cierresAdministrativosPendientes\": 0,\n \"byActionCategory\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"ageStats\": {\n \"avgDays\": 0,\n \"medianDays\": 0,\n \"maxDays\": 0\n },\n \"oldest\": [\n {\n \"id\": \"string\",\n \"source\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"estado\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"tribunal\": \"string\",\n \"fecha\": \"string\",\n \"rolYear\": 0,\n \"ageDays\": 0,\n \"ageApprox\": true,\n \"idleDays\": 0,\n \"verdict\": \"string\",\n \"blockers\": 0,\n \"pendingTotal\": 0,\n \"publicationsCaptured\": 0,\n \"familia\": \"string\"\n }\n ],\n \"openTasks\": 0,\n \"analysisUpdatedAt\": \"string\",\n \"estados\": [\n \"string\"\n ],\n \"tiposProcedimiento\": [\n \"string\"\n ],\n \"regiones\": [\n \"string\"\n ],\n \"byClosingWork\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"count\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidaciones simplificadas", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"estado\": \"\",\n \"omitEvidence\": false,\n \"omitExplanation\": false,\n \"summary\": false,\n \"explainFrom\": 0,\n \"explainCount\": 0\n }\n ]\n}" }, "description": "Get liquidaciones simplificadas\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "get-liquidations-simplificadas" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/get-liquidations-simplificadas" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"findings\": [\n {\n \"id\": \"string\",\n \"ruleKey\": \"string\",\n \"title\": \"string\",\n \"state\": \"string\",\n \"severity\": \"string\",\n \"explanation\": \"string\",\n \"reviewedState\": \"string\",\n \"taskId\": \"string\",\n \"reviewNote\": \"string\",\n \"reviewedAt\": \"2026-01-31T12:00:00Z\",\n \"evidence\": {\n \"source\": \"L\",\n \"items\": [\n \"string\"\n ],\n \"references\": [\n {\n \"id\": \"string\",\n \"source\": \"publications\",\n \"title\": \"string\",\n \"date\": \"string\",\n \"evidenceCandidate\": true\n }\n ]\n }\n }\n ],\n \"findingCount\": 0,\n \"blockerCount\": 0,\n \"cierre\": {\n \"estado\": \"string\",\n \"motivos\": [\n \"string\"\n ],\n \"detalle\": \"string\"\n },\n \"publicationsCount\": 0\n }\n ],\n \"byTipoProc\": [\n {\n \"tipoProcedimiento\": \"string\",\n \"total\": 0,\n \"sinPublicaciones\": 0,\n \"pendingHigh\": 0,\n \"pendingMedium\": 0\n }\n ],\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get solicitud30 UF", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get solicitud30 UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "get-solicitud30-uf" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/get-solicitud30-uf" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"estado\": {\n \"procedimientoId\": \"string\",\n \"cbcId\": \"string\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"deudor\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"estadoProcedimiento\": \"string\",\n \"origen\": \"string\",\n \"estadoFlujo\": \"string\",\n \"acciones\": {\n \"\u003ckey\u003e\": true\n },\n \"historia\": {},\n \"seenAt\": \"2026-01-31T12:00:00Z\"\n },\n \"slots\": [\n {\n \"field\": \"string\",\n \"label\": \"string\",\n \"required\": true,\n \"candidates\": [\n {\n \"sourceId\": \"string\",\n \"titulo\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n ],\n \"fechaAprobacion\": \"string\",\n \"boletasDesde\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get superir form", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get superir form\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "get-superir-form" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/get-superir-form" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"kind\": \"string\",\n \"options\": {},\n \"history\": {},\n \"today\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get superir overview", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get superir overview\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "get-superir-overview" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/get-superir-overview" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rol\": \"string\",\n \"honorarios30UF\": [\n {\n \"procedimientoId\": \"string\",\n \"cbcId\": \"string\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"deudor\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"estadoProcedimiento\": \"string\",\n \"origen\": \"ELEGIBLE\",\n \"estadoFlujo\": \"string\",\n \"acciones\": {\n \"\u003ckey\u003e\": true\n },\n \"historia\": {},\n \"seenAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"consultas\": {\n \"registroCivil\": {\n \"data\": {\n \"padres\": [\n {\n \"relacion\": \"string\",\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"fechaNacimiento\": \"string\",\n \"fechaDefuncion\": \"string\",\n \"posesionEfectiva\": \"string\"\n }\n ],\n \"vehiculos\": [\n {\n \"patente\": \"string\",\n \"tipo\": \"string\",\n \"marca\": \"string\",\n \"modelo\": \"string\",\n \"anio\": \"string\",\n \"color\": \"string\",\n \"nroMotor\": \"string\",\n \"chasis\": \"string\",\n \"vin\": \"string\",\n \"propietarios\": [\n {\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"fechaAdquisicion\": \"string\",\n \"oficinaInscripcion\": \"string\",\n \"nroInscripcion\": \"string\"\n }\n ],\n \"anotaciones\": [\n {\n \"anotacion\": \"string\",\n \"acreedor\": \"string\",\n \"fechaRepertorio\": \"string\",\n \"repertorio\": \"string\",\n \"numeroRepertorio\": \"string\",\n \"numeroDocumentoRol\": \"string\"\n }\n ],\n \"error\": \"string\"\n }\n ]\n },\n \"consultedAt\": \"2026-01-31T12:00:00Z\"\n },\n \"cmf\": {\n \"resumen\": [\n {\n \"tipo\": \"string\",\n \"nombre\": \"string\",\n \"desde\": \"string\",\n \"hasta\": \"string\",\n \"meses\": 0\n }\n ],\n \"registros\": 0,\n \"consultedAt\": \"2026-01-31T12:00:00Z\"\n }\n },\n \"cruces\": {\n \"vehiculosNoEnBienes\": [\n \"string\"\n ],\n \"cmfSinCreditoVerificado\": [\n \"string\"\n ]\n },\n \"envios\": [\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"values\": {},\n \"fileName\": \"string\",\n \"bienId\": \"string\",\n \"state\": \"SENDING\",\n \"receipt\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"error\": \"string\",\n \"createdAt\": \"string\",\n \"by\": \"string\"\n }\n ],\n \"sugerencias\": {\n \"ventasDirectas\": [\n {\n \"id\": \"string\",\n \"tipo\": \"string\",\n \"descripcion\": \"string\",\n \"estadoRealizacion\": \"string\",\n \"fechaRealizacion\": \"string\",\n \"montoRealizacion\": 0,\n \"origen\": \"string\",\n \"informada\": true\n }\n ],\n \"direcciones\": [\n \"string\"\n ],\n \"avisos\": [\n {\n \"clave\": \"cuenta-final\",\n \"asunto\": \"string\",\n \"desde\": \"2026-01-31\",\n \"vence\": \"2026-01-31\",\n \"informado\": true,\n \"comentarios\": \"string\"\n }\n ]\n },\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get superir UF", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get superir UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "get-superir-uf" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/get-superir-uf" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"fecha\": \"string\",\n \"valor\": 0,\n \"formatted\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List the organization's liquidador causas", "request": { "description": "List the organization's liquidador causas\n\nAuthentication: developer API key. Boletín Concursal causas where the organization acts as liquidador.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "developer-data", "liquidaciones", "causas" ], "query": [ { "description": "Partial match on rol, name or debtor RUT.", "disabled": true, "key": "search", "value": "" }, { "description": "Page number (default 1).", "disabled": true, "key": "page", "value": "" }, { "description": "Rows per page (default 50).", "disabled": true, "key": "perPage", "value": "" } ], "raw": "{{baseUrl}}/api/developer-data/liquidaciones/causas" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"page\": 0,\n \"perPage\": 0,\n \"total\": 0,\n \"pageCount\": 0,\n \"causas\": [\n {\n \"id\": \"string\",\n \"documentId\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"estado\": \"string\",\n \"deudorRut\": \"string\",\n \"tribunal\": \"string\",\n \"liquidador\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"ultimaGestion\": \"string\",\n \"fechaUltimaGestion\": \"string\",\n \"cantidadGestiones\": 0,\n \"region\": \"string\",\n \"rolSujeto\": \"string\",\n \"sujetoTitular\": \"string\",\n \"veedorAsociado\": \"string\",\n \"tieneMartilleros\": true,\n \"liquidadorAsociado\": true,\n \"fecha\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\"\n }\n ]\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Search liquidacion related causa candidates", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\"\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "queries", "search-liquidacion-related-cause-candidates" ], "raw": "{{baseUrl}}/api/actions/liquidations/queries/search-liquidacion-related-cause-candidates" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"candidates\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"competence\": \"SUPREMA\",\n \"caratulado\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Add liquidacion related causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaBcId\": \"\",\n \"relationType\": \"\",\n \"note\": \"\",\n \"causaId\": \"\",\n \"rol\": \"\",\n \"tribunal\": \"\",\n \"caratulado\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "mutations", "add-liquidacion-related-cause" ], "raw": "{{baseUrl}}/api/actions/liquidations/mutations/add-liquidacion-related-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"relationType\": \"ACCION_REVOCATORIA\",\n \"note\": \"string\",\n \"causaId\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"tribunal\": \"string\",\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"createdAt\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete liquidacion bitacora", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"causaBcId\": \"\"\n }\n ]\n}" }, "description": "Delete liquidacion bitacora\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "mutations", "delete-liquidacion-bitacora" ], "raw": "{{baseUrl}}/api/actions/liquidations/mutations/delete-liquidacion-bitacora" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete liquidacion operation", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete liquidacion operation\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "delete-liquidacion-operation" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/delete-liquidacion-operation" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"state\": \"string\",\n \"verified\": true,\n \"message\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Generate liquidacion draft", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Generate liquidacion draft\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "generate-liquidacion-draft" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/generate-liquidacion-draft" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"kind\": \"string\",\n \"state\": \"DRAFT\",\n \"body\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"contexto\": \"string\",\n \"sugerencia\": \"string\",\n \"opciones\": [\n {\n \"tipo\": \"liquidador\",\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"patrocinaEnCausa\": true,\n \"ultimoUso\": \"string\"\n }\n ],\n \"permiteNuevo\": true\n }\n ],\n \"files\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\"\n }\n ],\n \"error\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Remove liquidacion related causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaBcId\": \"\",\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "mutations", "remove-liquidacion-related-cause" ], "raw": "{{baseUrl}}/api/actions/liquidations/mutations/remove-liquidacion-related-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Review liquidacion communication link", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "review-liquidacion-communication-link" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/review-liquidacion-communication-link" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"state\": \"string\",\n \"targetThreadId\": \"string\",\n \"message\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Review liquidacion finding", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"findingId\": \"\",\n \"reviewedState\": \"\",\n \"reviewNote\": \"\",\n \"createTask\": false,\n \"assignedUserIds\": [],\n \"dueDate\": \"\"\n }\n ]\n}" }, "description": "Review liquidacion finding\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "mutations", "review-liquidacion-finding" ], "raw": "{{baseUrl}}/api/actions/liquidations/mutations/review-liquidacion-finding" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causaBcId\": \"string\",\n \"taskId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Review liquidacion requirement", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Review liquidacion requirement\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "review-liquidacion-requirement" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/review-liquidacion-requirement" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"state\": \"string\",\n \"taskId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Run superir consulta", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Run superir consulta\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "run-superir-consulta" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/run-superir-consulta" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rol\": \"string\",\n \"honorarios30UF\": [\n {\n \"procedimientoId\": \"string\",\n \"cbcId\": \"string\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"deudor\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"estadoProcedimiento\": \"string\",\n \"origen\": \"ELEGIBLE\",\n \"estadoFlujo\": \"string\",\n \"acciones\": {\n \"\u003ckey\u003e\": true\n },\n \"historia\": {},\n \"seenAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"consultas\": {\n \"registroCivil\": {\n \"data\": {\n \"padres\": [\n {\n \"relacion\": \"string\",\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"fechaNacimiento\": \"string\",\n \"fechaDefuncion\": \"string\",\n \"posesionEfectiva\": \"string\"\n }\n ],\n \"vehiculos\": [\n {\n \"patente\": \"string\",\n \"tipo\": \"string\",\n \"marca\": \"string\",\n \"modelo\": \"string\",\n \"anio\": \"string\",\n \"color\": \"string\",\n \"nroMotor\": \"string\",\n \"chasis\": \"string\",\n \"vin\": \"string\",\n \"propietarios\": [\n {\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"fechaAdquisicion\": \"string\",\n \"oficinaInscripcion\": \"string\",\n \"nroInscripcion\": \"string\"\n }\n ],\n \"anotaciones\": [\n {\n \"anotacion\": \"string\",\n \"acreedor\": \"string\",\n \"fechaRepertorio\": \"string\",\n \"repertorio\": \"string\",\n \"numeroRepertorio\": \"string\",\n \"numeroDocumentoRol\": \"string\"\n }\n ],\n \"error\": \"string\"\n }\n ]\n },\n \"consultedAt\": \"2026-01-31T12:00:00Z\"\n },\n \"cmf\": {\n \"resumen\": [\n {\n \"tipo\": \"string\",\n \"nombre\": \"string\",\n \"desde\": \"string\",\n \"hasta\": \"string\",\n \"meses\": 0\n }\n ],\n \"registros\": 0,\n \"consultedAt\": \"2026-01-31T12:00:00Z\"\n }\n },\n \"cruces\": {\n \"vehiculosNoEnBienes\": [\n \"string\"\n ],\n \"cmfSinCreditoVerificado\": [\n \"string\"\n ]\n },\n \"envios\": [\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"values\": {},\n \"fileName\": \"string\",\n \"bienId\": \"string\",\n \"state\": \"SENDING\",\n \"receipt\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"error\": \"string\",\n \"createdAt\": \"string\",\n \"by\": \"string\"\n }\n ],\n \"sugerencias\": {\n \"ventasDirectas\": [\n {\n \"id\": \"string\",\n \"tipo\": \"string\",\n \"descripcion\": \"string\",\n \"estadoRealizacion\": \"string\",\n \"fechaRealizacion\": \"string\",\n \"montoRealizacion\": 0,\n \"origen\": \"string\",\n \"informada\": true\n }\n ],\n \"direcciones\": [\n \"string\"\n ],\n \"avisos\": [\n {\n \"clave\": \"cuenta-final\",\n \"asunto\": \"string\",\n \"desde\": \"2026-01-31\",\n \"vence\": \"2026-01-31\",\n \"informado\": true,\n \"comentarios\": \"string\"\n }\n ]\n },\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save liquidacion communication draft", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "save-liquidacion-communication-draft" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/save-liquidacion-communication-draft" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"subject\": \"string\",\n \"body\": \"string\",\n \"attachments\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"mimeType\": \"string\",\n \"size\": 0,\n \"path\": \"string\",\n \"sha256\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save liquidacion draft", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Save liquidacion draft\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "save-liquidacion-draft" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/save-liquidacion-draft" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"kind\": \"string\",\n \"state\": \"DRAFT\",\n \"body\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"contexto\": \"string\",\n \"sugerencia\": \"string\",\n \"opciones\": [\n {\n \"tipo\": \"liquidador\",\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"patrocinaEnCausa\": true,\n \"ultimoUso\": \"string\"\n }\n ],\n \"permiteNuevo\": true\n }\n ],\n \"files\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\"\n }\n ],\n \"error\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Send liquidacion operation", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Send liquidacion operation\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "send-liquidacion-operation" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/send-liquidacion-operation" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"recordId\": \"string\",\n \"state\": \"string\",\n \"verified\": true,\n \"message\": \"string\",\n \"portalId\": \"string\",\n \"portalState\": \"string\",\n \"page\": {\n \"title\": \"string\",\n \"text\": \"string\",\n \"tables\": [\n {\n \"title\": \"string\",\n \"headers\": [\n \"string\"\n ],\n \"rows\": [\n []\n ]\n }\n ],\n \"links\": [\n {\n \"label\": \"string\",\n \"url\": \"string\"\n }\n ]\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Send solicitud30 UF", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Send solicitud30 UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "send-solicitud30-uf" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/send-solicitud30-uf" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"state\": \"string\",\n \"duplicate\": true,\n \"receipt\": {\n \"estadoFlujo\": \"string\",\n \"rol\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Send superir envio", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Send superir envio\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "send-superir-delivery" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/send-superir-delivery" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"state\": \"string\",\n \"duplicate\": true,\n \"receipt\": {\n \"\u003ckey\u003e\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set liquidacion assignees", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaBcId\": \"\",\n \"userIds\": []\n }\n ]\n}" }, "description": "Set liquidacion assignees\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "mutations", "set-liquidacion-assignees" ], "raw": "{{baseUrl}}/api/actions/liquidations/mutations/set-liquidacion-assignees" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"assignedUserIds\": [\n \"string\"\n ],\n \"assignees\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Sync honorarios30 UF", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Sync honorarios30 UF\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "superir", "sync-honorarios30-uf" ], "raw": "{{baseUrl}}/api/actions/liquidations/superir/sync-honorarios30-uf" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rows\": [\n {\n \"procedimientoId\": \"string\",\n \"cbcId\": \"string\",\n \"rol\": \"string\",\n \"tribunal\": \"string\",\n \"deudor\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"estadoProcedimiento\": \"string\",\n \"origen\": \"string\",\n \"estadoFlujo\": \"string\",\n \"acciones\": {\n \"\u003ckey\u003e\": true\n },\n \"historia\": {},\n \"seenAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"syncedAt\": \"2026-01-31T12:00:00Z\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Sync liquidacion workspace", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Sync liquidacion workspace\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "portal", "sync-liquidacion-workspace" ], "raw": "{{baseUrl}}/api/actions/liquidations/portal/sync-liquidacion-workspace" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"state\": \"string\",\n \"queued\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upsert liquidacion bitacora", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"causaBcId\": \"\",\n \"title\": \"\",\n \"content\": \"\"\n }\n ]\n}" }, "description": "Upsert liquidacion bitacora\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "mutations", "upsert-liquidacion-bitacora" ], "raw": "{{baseUrl}}/api/actions/liquidations/mutations/upsert-liquidacion-bitacora" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"bitacora\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"orgId\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upsert liquidacion movement note", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"targetType\": \"\",\n \"targetId\": \"\",\n \"itemDesc\": \"\",\n \"text\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "mutations", "upsert-liquidacion-movement-note" ], "raw": "{{baseUrl}}/api/actions/liquidations/mutations/upsert-liquidacion-movement-note" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"note\": {\n \"id\": \"string\",\n \"text\": \"string\",\n \"itemDesc\": \"string\",\n \"orgId\": \"string\",\n \"modifiedById\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upsert liquidacion note", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaBcId\": \"\",\n \"itemDesc\": \"\",\n \"text\": \"\"\n }\n ]\n}" }, "description": "Upsert liquidacion note\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidations", "mutations", "upsert-liquidacion-note" ], "raw": "{{baseUrl}}/api/actions/liquidations/mutations/upsert-liquidacion-note" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"note\": {\n \"id\": \"string\",\n \"text\": \"string\",\n \"itemDesc\": \"string\",\n \"orgId\": \"string\",\n \"causaBcId\": \"string\",\n \"modifiedById\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Liquidations" }, { "item": [ { "name": "Get clients", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"search\": \"\",\n \"credentialType\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "clients", "queries", "get-clients" ], "raw": "{{baseUrl}}/api/actions/clients/queries/get-clients" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"clients\": [\n {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"organizationName\": \"string\",\n \"name\": \"string\",\n \"rut\": \"string\",\n \"withCU\": true,\n \"hasCredential\": true,\n \"passwordType\": \"string\",\n \"statusClave\": \"OK\",\n \"lastCheck\": \"2026-01-31T12:00:00Z\",\n \"defaultClient\": true,\n \"isInternalLawyer\": true,\n \"profesion\": \"string\",\n \"address\": \"string\",\n \"note\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"clients:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get clients summary", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Get clients summary\n\nAuthentication: developer API key. Required scope: `clients:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "clients", "queries", "get-clients-summary" ], "raw": "{{baseUrl}}/api/actions/clients/queries/get-clients-summary" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"organizationId\": \"string\",\n \"organizationName\": \"string\",\n \"liquidadorEnabled\": true,\n \"canWriteSii\": true,\n \"kpis\": {\n \"clients\": 0,\n \"withCU\": 0,\n \"statusOk\": 0,\n \"incorrect\": 0,\n \"blocked\": 0,\n \"error\": 0,\n \"unvalidated\": 0,\n \"noCredential\": 0,\n \"causasBlocked\": 0,\n \"deudores\": 0,\n \"deudoresWithSii\": 0,\n \"deudoresWithoutSii\": 0\n },\n \"clients\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"rut\": \"string\",\n \"withCU\": true,\n \"hasCredential\": true,\n \"passwordType\": \"string\",\n \"statusClave\": \"OK\",\n \"lastCheck\": \"2026-01-31T12:00:00Z\",\n \"defaultClient\": true,\n \"isInternalLawyer\": true,\n \"profesion\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"causas\": 0,\n \"causasBlocked\": 0,\n \"expedientes\": 0\n }\n ],\n \"blockedCauses\": [\n {\n \"causaId\": \"string\",\n \"rol\": \"string\",\n \"competence\": \"CIVIL\",\n \"caratulado\": \"string\",\n \"errorCategory\": \"INIT_TIMEOUT\",\n \"lastUpdate\": \"2026-01-31T12:00:00Z\",\n \"clientId\": \"string\",\n \"clientName\": \"string\",\n \"clientStatus\": \"OK\"\n }\n ],\n \"detectedParties\": [\n {\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"role\": \"string\",\n \"causas\": 0,\n \"sources\": [\n \"string\"\n ]\n }\n ],\n \"lawyers\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"invitation\": \"string\",\n \"responsibleCausas\": 0,\n \"blockedCausas\": 0,\n \"deudores\": 0,\n \"internalLawyerClientId\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"clients:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List client link suggestions", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"search\": \"\",\n \"countOnly\": false,\n \"limit\": 0,\n \"offset\": 0,\n \"noClients\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "clients", "link", "list-client-link-suggestions" ], "raw": "{{baseUrl}}/api/actions/clients/link/list-client-link-suggestions" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"competence\": \"string\",\n \"litigantes\": [\n {\n \"personaId\": \"string\",\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"participante\": \"string\",\n \"matchClientId\": \"string\",\n \"matchClientName\": \"string\"\n }\n ]\n }\n ],\n \"total\": 0,\n \"matched\": 0,\n \"canEdit\": true,\n \"clients\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"rut\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"clients:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create client", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"rut\": \"\",\n \"withCU\": false,\n \"defaultClient\": false,\n \"isInternalLawyer\": false,\n \"passwordType\": \"\",\n \"claveUnica\": \"\",\n \"profesion\": \"\",\n \"address\": \"\",\n \"note\": \"\"\n }\n ]\n}" }, "description": "Create client\n\nAuthentication: developer API key. Required scope: `clients:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "clients", "mutations", "create-client" ], "raw": "{{baseUrl}}/api/actions/clients/mutations/create-client" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true,\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"clients:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create client from litigant", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\",\n \"name\": \"\",\n \"rut\": \"\",\n \"email\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "clients", "link", "create-client-from-litigant" ], "raw": "{{baseUrl}}/api/actions/clients/link/create-client-from-litigant" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"clientId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"clients:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Link causa client", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\",\n \"clientId\": \"\"\n }\n ]\n}" }, "description": "Link causa client\n\nAuthentication: developer API key. Required scope: `clients:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "clients", "link", "link-cause-client" ], "raw": "{{baseUrl}}/api/actions/clients/link/link-cause-client" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"clients:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Link suggested clients", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaIds\": []\n }\n ]\n}" }, "description": "Link suggested clients\n\nAuthentication: developer API key. Required scope: `clients:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "clients", "link", "link-suggested-clients" ], "raw": "{{baseUrl}}/api/actions/clients/link/link-suggested-clients" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"linked\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"clients:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Update client", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"rut\": \"\",\n \"withCU\": false,\n \"defaultClient\": false,\n \"isInternalLawyer\": false,\n \"passwordType\": \"\",\n \"claveUnica\": \"\",\n \"profesion\": \"\",\n \"address\": \"\",\n \"note\": \"\"\n }\n ]\n}" }, "description": "Update client\n\nAuthentication: developer API key. Required scope: `clients:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "clients", "mutations", "update-client" ], "raw": "{{baseUrl}}/api/actions/clients/mutations/update-client" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true,\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"clients:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Clients" }, { "item": [ { "name": "Get causa movement documents", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\u003cCASE_ID\u003e\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tasks", "queries", "get-cause-movement-documents" ], "raw": "{{baseUrl}}/api/actions/tasks/queries/get-cause-movement-documents" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"documents\": [\n {\n \"sourceType\": \"string\",\n \"sourceId\": \"string\",\n \"label\": \"string\",\n \"fileName\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"tasks:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get task documents", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"taskId\": \"\",\n \"documentId\": \"\",\n \"sourceType\": \"\",\n \"sourceId\": \"\",\n \"causaId\": \"\"\n }\n ]\n}" }, "description": "Get task documents\n\nAuthentication: developer API key. Required scope: `tasks:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tasks", "queries", "get-task-documents" ], "raw": "{{baseUrl}}/api/actions/tasks/queries/get-task-documents" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"documents\": [\n {\n \"id\": \"string\",\n \"sourceType\": \"string\",\n \"sourceId\": \"string\",\n \"path\": \"string\",\n \"fileName\": \"string\",\n \"label\": \"string\",\n \"causaId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"tasks:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get task events", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"taskId\": \"\"\n }\n ]\n}" }, "description": "Get task events\n\nAuthentication: developer API key. Required scope: `tasks:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tasks", "review", "get-task-events" ], "raw": "{{baseUrl}}/api/actions/tasks/review/get-task-events" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"events\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"from\": \"string\",\n \"to\": \"string\",\n \"payload\": {},\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"actorId\": \"string\",\n \"actorName\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"tasks:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get tasks", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"search\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"assigneeId\": \"\",\n \"dueFrom\": \"\",\n \"dueTo\": \"\",\n \"statuses\": [],\n \"closedFrom\": \"\",\n \"closedTo\": \"\",\n \"reviewerId\": \"\",\n \"sort\": \"\",\n \"page\": 0,\n \"perPage\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tasks", "queries", "get-tasks" ], "raw": "{{baseUrl}}/api/actions/tasks/queries/get-tasks" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"tasks\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"status\": \"string\",\n \"priority\": \"string\",\n \"dueDate\": \"2026-01-31T12:00:00Z\",\n \"dueEnd\": \"2026-01-31T12:00:00Z\",\n \"isCompleted\": true,\n \"completedAt\": \"2026-01-31T12:00:00Z\",\n \"orgId\": \"string\",\n \"teamId\": \"string\",\n \"causaId\": \"string\",\n \"internalCauseId\": \"string\",\n \"causaLabel\": \"string\",\n \"assignedUserIds\": [\n \"string\"\n ],\n \"reviewerId\": \"string\",\n \"sortOrder\": 0,\n \"sourceType\": \"string\",\n \"sourceId\": \"string\",\n \"documents\": [\n {\n \"id\": \"string\",\n \"sourceType\": \"string\",\n \"sourceId\": \"string\",\n \"path\": \"string\",\n \"fileName\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"total\": 0,\n \"page\": 0,\n \"pageCount\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"tasks:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Add task document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"taskId\": \"\",\n \"documentId\": \"\",\n \"sourceType\": \"\",\n \"sourceId\": \"\",\n \"causaId\": \"\"\n }\n ]\n}" }, "description": "Add task document\n\nAuthentication: developer API key. Required scope: `tasks:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tasks", "mutations", "add-task-document" ], "raw": "{{baseUrl}}/api/actions/tasks/mutations/add-task-document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"document\": {\n \"id\": \"string\",\n \"sourceType\": \"string\",\n \"sourceId\": \"string\",\n \"path\": \"string\",\n \"fileName\": \"string\",\n \"label\": \"string\",\n \"causaId\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"tasks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create task", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"dueDate\": \"\",\n \"dueEnd\": \"\",\n \"teamId\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"assignedUserIds\": [],\n \"reviewerId\": \"\",\n \"sourceType\": \"\",\n \"sourceId\": \"\"\n }\n ]\n}" }, "description": "Create task\n\nAuthentication: developer API key. Required scope: `tasks:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tasks", "mutations", "create-task" ], "raw": "{{baseUrl}}/api/actions/tasks/mutations/create-task" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"tasks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Remove task document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"taskId\": \"\",\n \"documentId\": \"\",\n \"sourceType\": \"\",\n \"sourceId\": \"\",\n \"causaId\": \"\"\n }\n ]\n}" }, "description": "Remove task document\n\nAuthentication: developer API key. Required scope: `tasks:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tasks", "mutations", "remove-task-document" ], "raw": "{{baseUrl}}/api/actions/tasks/mutations/remove-task-document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"documentId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"tasks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Update task", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"dueDate\": \"\",\n \"dueEnd\": \"\",\n \"teamId\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"assignedUserIds\": [],\n \"reviewerId\": \"\",\n \"sourceType\": \"\",\n \"sourceId\": \"\"\n }\n ]\n}" }, "description": "Update task\n\nAuthentication: developer API key. Required scope: `tasks:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tasks", "mutations", "update-task" ], "raw": "{{baseUrl}}/api/actions/tasks/mutations/update-task" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"tasks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Tasks" }, { "item": [ { "name": "Export time entries", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"from\": \"\",\n \"to\": \"\",\n \"clientId\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"userId\": \"\",\n \"billable\": \"\",\n \"format\": \"\",\n \"locale\": \"\"\n }\n ]\n}" }, "description": "Export time entries\n\nAuthentication: developer API key. Required scope: `time:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "export-time-entries" ], "raw": "{{baseUrl}}/api/actions/time/tracker/export-time-entries" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"filename\": \"string\",\n \"base64\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get billing analytics", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n}" }, "description": "Get billing analytics\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "get-billing-analytics" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/get-billing-analytics" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"from\": \"2026-01-31\",\n \"to\": \"2026-01-31\",\n \"totals\": [\n {\n \"currency\": \"string\",\n \"collected\": 0,\n \"tax\": 0,\n \"net\": 0,\n \"pending\": 0,\n \"overdue\": 0\n }\n ],\n \"byMonth\": [\n {\n \"month\": \"string\",\n \"currency\": \"string\",\n \"billed\": 0,\n \"collected\": 0\n }\n ],\n \"byStatus\": [\n {\n \"status\": \"DRAFT\",\n \"currency\": \"string\",\n \"count\": 0,\n \"total\": 0\n }\n ],\n \"topClients\": [\n {\n \"client\": \"string\",\n \"currency\": \"string\",\n \"billed\": 0,\n \"collected\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get billing bank account", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "get-billing-bank-account" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/get-billing-bank-account" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"bank\": {\n \"bank\": \"string\",\n \"accountType\": \"string\",\n \"number\": \"string\",\n \"holderRut\": \"string\",\n \"holderName\": \"string\",\n \"email\": \"string\"\n },\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get billing note", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get billing note\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "get-billing-note" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/get-billing-note" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"note\": {\n \"id\": \"string\",\n \"number\": 0,\n \"clientId\": \"string\",\n \"clientName\": \"string\",\n \"clientRut\": \"string\",\n \"status\": \"string\",\n \"issuedAt\": \"2026-01-31T12:00:00Z\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"currency\": \"string\",\n \"net\": 0,\n \"taxRate\": 0,\n \"tax\": 0,\n \"total\": 0,\n \"periodFrom\": \"2026-01-31T12:00:00Z\",\n \"periodTo\": \"2026-01-31T12:00:00Z\",\n \"notes\": \"string\",\n \"paidAt\": \"2026-01-31T12:00:00Z\",\n \"paymentReference\": \"string\",\n \"automatic\": true,\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n },\n \"lines\": [\n {\n \"kind\": \"string\",\n \"description\": \"string\",\n \"quantity\": 0,\n \"unitAmount\": 0,\n \"amount\": 0\n }\n ],\n \"bank\": {\n \"bank\": \"string\",\n \"accountType\": \"string\",\n \"number\": \"string\",\n \"holderRut\": \"string\",\n \"holderName\": \"string\",\n \"email\": \"string\"\n },\n \"orgName\": \"string\",\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get time reports", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"from\": \"\",\n \"to\": \"\",\n \"clientId\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"userId\": \"\",\n \"billable\": \"\",\n \"format\": \"\",\n \"locale\": \"\"\n }\n ]\n}" }, "description": "Get time reports\n\nAuthentication: developer API key. Required scope: `time:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "get-time-reports" ], "raw": "{{baseUrl}}/api/actions/time/tracker/get-time-reports" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"from\": \"string\",\n \"to\": \"string\",\n \"byDay\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"minutes\": 0,\n \"billableMinutes\": 0\n }\n ],\n \"byUser\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"minutes\": 0,\n \"billableMinutes\": 0\n }\n ],\n \"byClient\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"minutes\": 0,\n \"billableMinutes\": 0\n }\n ],\n \"topCausas\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"minutes\": 0,\n \"billableMinutes\": 0\n }\n ],\n \"totals\": {\n \"minutes\": 0,\n \"billableMinutes\": 0\n },\n \"viewAll\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get timer assignment options", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "get-timer-assignment-options" ], "raw": "{{baseUrl}}/api/actions/time/tracker/get-timer-assignment-options" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"clients\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"causas\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"internalCauses\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List billing automations", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "List billing automations\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "list-billing-automations" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/list-billing-automations" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"clients\": [\n {\n \"clientId\": \"string\",\n \"clientName\": \"string\",\n \"rateId\": \"string\",\n \"rateName\": \"string\",\n \"frequency\": \"string\",\n \"dayOfMonth\": 0,\n \"dayOfWeek\": 0,\n \"dueDays\": 0,\n \"nextRunAt\": \"2026-01-31T12:00:00Z\",\n \"autoIssue\": true\n }\n ],\n \"rates\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"hourlyAmount\": 0,\n \"fixedAmount\": 0,\n \"fixedDescription\": \"string\",\n \"currency\": \"string\",\n \"clients\": 0\n }\n ],\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List billing notes", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"tab\": \"\",\n \"clientId\": \"\"\n }\n ]\n}" }, "description": "List billing notes\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "list-billing-notes" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/list-billing-notes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"tab\": \"string\",\n \"notes\": [\n {\n \"id\": \"string\",\n \"number\": 0,\n \"clientId\": \"string\",\n \"clientName\": \"string\",\n \"clientRut\": \"string\",\n \"status\": \"string\",\n \"issuedAt\": \"2026-01-31T12:00:00Z\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"currency\": \"string\",\n \"net\": 0,\n \"taxRate\": 0,\n \"tax\": 0,\n \"total\": 0,\n \"periodFrom\": \"2026-01-31T12:00:00Z\",\n \"periodTo\": \"2026-01-31T12:00:00Z\",\n \"notes\": \"string\",\n \"paidAt\": \"2026-01-31T12:00:00Z\",\n \"paymentReference\": \"string\",\n \"automatic\": true,\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"clients\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List billing rates", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "List billing rates\n\nAuthentication: developer API key. Required scope: `billing:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "list-billing-rates" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/list-billing-rates" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rates\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"hourlyAmount\": 0,\n \"fixedAmount\": 0,\n \"fixedDescription\": \"string\",\n \"currency\": \"string\",\n \"clients\": 0\n }\n ],\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Assign timer", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"clientId\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"taskId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "assign-timer" ], "raw": "{{baseUrl}}/api/actions/time/tracker/assign-timer" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Cancel billing note", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {}\n ]\n}" }, "description": "Cancel billing note\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "cancel-billing-note" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/cancel-billing-note" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create billing note", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"clientId\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"currency\": \"\",\n \"taxRate\": 0,\n \"includeHours\": false,\n \"includeFixed\": false,\n \"lines\": [],\n \"notes\": \"\",\n \"issue\": false\n }\n ]\n}" }, "description": "Create billing note\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "create-billing-note" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/create-billing-note" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"number\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete billing rate", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete billing rate\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "delete-billing-rate" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/delete-billing-rate" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete time entry", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete time entry\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "delete-time-entry" ], "raw": "{{baseUrl}}/api/actions/time/tracker/delete-time-entry" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get running timer", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "get-running-timer" ], "raw": "{{baseUrl}}/api/actions/time/tracker/get-running-timer" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"timer\": {\n \"id\": \"string\",\n \"legacy\": true,\n \"userId\": \"string\",\n \"userName\": \"string\",\n \"clientId\": \"string\",\n \"clientName\": \"string\",\n \"causaId\": \"string\",\n \"causaLabel\": \"string\",\n \"internalCauseId\": \"string\",\n \"internalCauseLabel\": \"string\",\n \"taskId\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"accumulatedSeconds\": 0,\n \"activeSince\": \"2026-01-31T12:00:00Z\",\n \"pausedAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"minutes\": 0,\n \"description\": \"string\",\n \"billable\": true,\n \"hourlyRate\": 0,\n \"currency\": \"string\",\n \"source\": \"string\",\n \"billingNoteId\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Import hearing", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"minutes\": 0,\n \"locale\": \"\"\n }\n ]\n}" }, "description": "Import hearing\n\nAuthentication: developer API key. Required scope: `time:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "import-hearing" ], "raw": "{{baseUrl}}/api/actions/time/tracker/import-hearing" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Issue billing note", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {}\n ]\n}" }, "description": "Issue billing note\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "issue-billing-note" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/issue-billing-note" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List time entries", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"from\": \"\",\n \"to\": \"\",\n \"clientId\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"userId\": \"\",\n \"billable\": \"\",\n \"format\": \"\",\n \"locale\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "list-time-entries" ], "raw": "{{baseUrl}}/api/actions/time/tracker/list-time-entries" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"entries\": [\n {\n \"id\": \"string\",\n \"legacy\": true,\n \"userId\": \"string\",\n \"userName\": \"string\",\n \"clientId\": \"string\",\n \"clientName\": \"string\",\n \"causaId\": \"string\",\n \"causaLabel\": \"string\",\n \"internalCauseId\": \"string\",\n \"internalCauseLabel\": \"string\",\n \"taskId\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"accumulatedSeconds\": 0,\n \"activeSince\": \"2026-01-31T12:00:00Z\",\n \"pausedAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"minutes\": 0,\n \"description\": \"string\",\n \"billable\": true,\n \"hourlyRate\": 0,\n \"currency\": \"string\",\n \"source\": \"string\",\n \"billingNoteId\": \"string\"\n }\n ],\n \"totals\": {\n \"minutes\": 0,\n \"billableMinutes\": 0,\n \"entries\": 0\n },\n \"running\": {\n \"id\": \"string\",\n \"legacy\": true,\n \"userId\": \"string\",\n \"userName\": \"string\",\n \"clientId\": \"string\",\n \"clientName\": \"string\",\n \"causaId\": \"string\",\n \"causaLabel\": \"string\",\n \"internalCauseId\": \"string\",\n \"internalCauseLabel\": \"string\",\n \"taskId\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"accumulatedSeconds\": 0,\n \"activeSince\": \"2026-01-31T12:00:00Z\",\n \"pausedAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"minutes\": 0,\n \"description\": \"string\",\n \"billable\": true,\n \"hourlyRate\": 0,\n \"currency\": \"string\",\n \"source\": \"string\",\n \"billingNoteId\": \"string\"\n },\n \"options\": {\n \"clients\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"causas\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"internalCauses\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"users\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"viewAll\": true,\n \"userId\": \"string\"\n },\n \"hearings\": [\n {\n \"id\": \"string\",\n \"causaId\": \"string\",\n \"label\": \"string\",\n \"kind\": \"string\",\n \"kindEs\": \"string\",\n \"kindEn\": \"string\",\n \"startsAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Mark billing note paid", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {}\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "mark-billing-note-paid" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/mark-billing-note-paid" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Pause timer", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "pause-timer" ], "raw": "{{baseUrl}}/api/actions/time/tracker/pause-timer" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Resume timer", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "resume-timer" ], "raw": "{{baseUrl}}/api/actions/time/tracker/resume-timer" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save billing automation", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"clientId\": \"\",\n \"rateId\": \"\",\n \"frequency\": \"\",\n \"dayOfMonth\": 0,\n \"dayOfWeek\": 0,\n \"dueDays\": 0,\n \"autoIssue\": false\n }\n ]\n}" }, "description": "Save billing automation\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "save-billing-automation" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/save-billing-automation" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true,\n \"nextRunAt\": \"2026-01-31T12:00:00Z\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save billing bank account", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {}\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "save-billing-bank-account" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/save-billing-bank-account" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save billing rate", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"hourlyAmount\": 0,\n \"fixedAmount\": 0,\n \"fixedDescription\": \"\",\n \"currency\": \"\"\n }\n ]\n}" }, "description": "Save billing rate\n\nAuthentication: developer API key. Required scope: `billing:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cobranza", "billing", "save-billing-rate" ], "raw": "{{baseUrl}}/api/actions/cobranza/billing/save-billing-rate" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"billing:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save time entry", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"clientId\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"taskId\": \"\",\n \"id\": \"\",\n \"date\": \"\",\n \"start\": \"\",\n \"minutes\": 0,\n \"description\": \"\",\n \"billable\": false,\n \"hourlyRate\": 0,\n \"currency\": \"\",\n \"userId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "save-time-entry" ], "raw": "{{baseUrl}}/api/actions/time/tracker/save-time-entry" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Start timer", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"clientId\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"taskId\": \"\",\n \"description\": \"\",\n \"billable\": false,\n \"source\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "start-timer" ], "raw": "{{baseUrl}}/api/actions/time/tracker/start-timer" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Stop timer", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "time", "tracker", "stop-timer" ], "raw": "{{baseUrl}}/api/actions/time/tracker/stop-timer" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"minutes\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"time:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Time and billing" }, { "item": [ { "name": "Chat with the legal AI assistant", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"messages\": \"\u003cmessages\u003e\"\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "assistant", "chat" ], "raw": "{{baseUrl}}/api/assistant/chat" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"answer\": \"string\",\n \"sources\": [\n {\n \"kind\": \"ley\",\n \"ref\": \"string\",\n \"title\": \"string\",\n \"url\": \"string\",\n \"snippet\": \"string\",\n \"score\": 0\n }\n ],\n \"model\": \"string\",\n \"warnings\": [\n \"string\"\n ],\n \"conversationId\": \"string\",\n \"messageId\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete assistant conversation", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete assistant conversation\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "assistant", "conversations", "delete-assistant-conversation" ], "raw": "{{baseUrl}}/api/actions/assistant/conversations/delete-assistant-conversation" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Draft a task from a case movement", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"causaId\": \"\u003ccausaId\u003e\",\n \"sourceId\": \"\u003csourceId\u003e\",\n \"sourceType\": \"\u003csourceType\u003e\"\n}" }, "description": "Draft a task from a case movement\n\nAuthentication: developer API key with `ai:use` scope. AI usage may be metered.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "assistant", "task-draft" ], "raw": "{{baseUrl}}/api/assistant/task-draft" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"title\": \"string\",\n \"description\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Export assistant message", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\",\n \"format\": \"\"\n }\n ]\n}" }, "description": "Export assistant message\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "assistant", "documents", "export-assistant-message" ], "raw": "{{baseUrl}}/api/actions/assistant/documents/export-assistant-message" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"name\": \"string\",\n \"mime\": \"string\",\n \"contentBase64\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get assistant conversation", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get assistant conversation\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "assistant", "conversations", "get-assistant-conversation" ], "raw": "{{baseUrl}}/api/actions/assistant/conversations/get-assistant-conversation" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversation\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"caseId\": \"string\",\n \"caseKind\": \"string\",\n \"caseLabel\": \"string\",\n \"mode\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n },\n \"messages\": [\n {\n \"id\": \"string\",\n \"role\": \"string\",\n \"content\": \"string\",\n \"sources\": [\n {\n \"kind\": \"string\",\n \"ref\": \"string\",\n \"title\": \"string\",\n \"url\": \"string\",\n \"snippet\": \"string\",\n \"score\": 0\n }\n ],\n \"warnings\": [\n \"string\"\n ],\n \"caseLabel\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List assistant conversations", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"q\": \"\",\n \"limit\": 0,\n \"offset\": 0\n }\n ]\n}" }, "description": "List assistant conversations\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "assistant", "conversations", "list-assistant-conversations" ], "raw": "{{baseUrl}}/api/actions/assistant/conversations/list-assistant-conversations" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversations\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"caseId\": \"string\",\n \"caseKind\": \"string\",\n \"caseLabel\": \"string\",\n \"mode\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List assistant templates", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {}\n ]\n}" }, "description": "List assistant templates\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "assistant", "templates", "list-assistant-templates" ], "raw": "{{baseUrl}}/api/actions/assistant/templates/list-assistant-templates" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"templates\": [\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Read organization AI instructions", "request": { "description": "Read organization AI instructions\n\nAuthentication: developer API key with `ai:use` scope.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "assistant", "instructions" ], "raw": "{{baseUrl}}/api/assistant/instructions" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"organizationId\": \"string\",\n \"organizationName\": \"string\",\n \"canEdit\": true,\n \"organizationContextEnabled\": true,\n \"state\": {\n \"version\": 0,\n \"files\": [\n {\n \"name\": \"string\",\n \"content\": \"string\",\n \"enabled\": true\n }\n ],\n \"updatedBy\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Rename assistant conversation", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ]\n}" }, "description": "Rename assistant conversation\n\nAuthentication: developer API key. Required scope: `ai:use`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "assistant", "conversations", "rename-assistant-conversation" ], "raw": "{{baseUrl}}/api/actions/assistant/conversations/rename-assistant-conversation" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Search organization cases for AI context", "request": { "description": "Search organization cases for AI context\n\nAuthentication: developer API key with `ai:use` scope.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "assistant", "cases" ], "query": [ { "description": "The key's organization id.", "disabled": false, "key": "organizationId", "value": "" }, { "description": "Case search text.", "disabled": true, "key": "q", "value": "" } ], "raw": "{{baseUrl}}/api/assistant/cases?organizationId=" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"cases\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"title\": \"string\",\n \"kind\": \"tracked\"\n }\n ]\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"ai:use\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Artificial intelligence" }, { "item": [ { "name": "Compile liquidator writing", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Compile liquidator writing\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "mutations", "compile-liquidator-writing" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/mutations/compile-liquidator-writing" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"label\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Complete liquidator writing draft", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "mutations", "complete-liquidator-writing-draft" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/mutations/complete-liquidator-writing-draft" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"artifact\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"kind\": \"string\",\n \"state\": \"DRAFT\",\n \"body\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"contexto\": \"string\",\n \"sugerencia\": \"string\",\n \"opciones\": [\n {\n \"tipo\": \"liquidador\",\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"patrocinaEnCausa\": true,\n \"ultimoUso\": \"string\"\n }\n ],\n \"permiteNuevo\": true\n }\n ],\n \"files\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\"\n }\n ],\n \"error\": \"string\"\n },\n \"escrito\": {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"label\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Detect liquidator writings", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Detect liquidator writings\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "mutations", "detect-liquidator-writings" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/mutations/detect-liquidator-writings" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"created\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Download a file from a signed storage URL", "request": { "auth": { "type": "noauth" }, "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.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "storage", "files", "download" ], "query": [ { "description": "Signed storage path.", "disabled": false, "key": "path", "value": "" }, { "description": "Expiry as a Unix timestamp.", "disabled": false, "key": "expires", "value": "" }, { "description": "HMAC signature for the path and expiry.", "disabled": false, "key": "sig", "value": "" } ], "raw": "{{baseUrl}}/api/storage/files/download?expires=\u0026path=\u0026sig=" } }, "response": [ { "_postman_previewlanguage": "json", "body": "\u003capplication/octet-stream file\u003e", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success (file)", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get cuenta provisoria pdf url", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cuentas-provisorias", "queries", "get-cuenta-provisoria-pdf-url" ], "raw": "{{baseUrl}}/api/actions/cuentas-provisorias/queries/get-cuenta-provisoria-pdf-url" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"previewUrl\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get cuentas provisorias causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cuentas-provisorias", "queries", "get-cuentas-provisorias-cause" ], "raw": "{{baseUrl}}/api/actions/cuentas-provisorias/queries/get-cuentas-provisorias-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"available\": true,\n \"meses\": [\n {\n \"periodo\": \"string\",\n \"estado\": \"string\",\n \"bcCuentaId\": \"string\",\n \"totIng\": 0,\n \"totEgr\": 0,\n \"dif\": 0,\n \"saldoCtaCte\": 0,\n \"inversion\": 0,\n \"liquidador\": \"string\",\n \"detalle\": null,\n \"pdfPath\": \"string\",\n \"pdfAt\": \"2026-01-31T12:00:00Z\",\n \"pubId\": \"string\",\n \"pubAt\": \"2026-01-31T12:00:00Z\",\n \"syncedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"tareas\": [\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"periodo\": \"string\",\n \"state\": \"string\",\n \"paso\": \"string\",\n \"error\": \"string\",\n \"dryRun\": true,\n \"result\": null,\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"due\": \"string\",\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get cuentas provisorias overview", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"kind\": \"\",\n \"periodo\": \"\",\n \"dryRun\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cuentas-provisorias", "queries", "get-cuentas-provisorias-overview" ], "raw": "{{baseUrl}}/api/actions/cuentas-provisorias/queries/get-cuentas-provisorias-overview" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"periodo\": \"string\",\n \"due\": \"string\",\n \"canManage\": true,\n \"rows\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"tribunal\": \"string\",\n \"documentId\": \"string\",\n \"causaId\": \"string\",\n \"mes\": {\n \"estado\": \"string\",\n \"totIng\": 0,\n \"totEgr\": 0,\n \"dif\": 0,\n \"pdf\": true,\n \"cuadra\": true,\n \"pubId\": \"string\",\n \"pubAt\": \"string\",\n \"syncedAt\": \"string\"\n },\n \"bcPub\": {\n \"fecha\": \"string\",\n \"estado\": \"string\"\n },\n \"ultimoMes\": \"string\",\n \"meses\": 0,\n \"tarea\": {\n \"id\": \"string\",\n \"kind\": \"AUTO\",\n \"state\": \"string\",\n \"paso\": \"string\",\n \"error\": \"string\",\n \"dryRun\": true,\n \"result\": {\n \"periodo\": \"string\",\n \"pasos\": [\n \"string\"\n ],\n \"meses\": 0,\n \"resultado\": 0,\n \"fondoTotal\": 0\n },\n \"updatedAt\": \"string\"\n }\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get drive document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get drive document\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "docs", "get-drive-document" ], "raw": "{{baseUrl}}/api/actions/drive/docs/get-drive-document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"file\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"kind\": \"FILE\",\n \"mime\": \"string\",\n \"size\": 0,\n \"version\": 0,\n \"personal\": true,\n \"folderId\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"deletedAt\": \"2026-01-31T12:00:00Z\",\n \"reviewStatus\": \"string\",\n \"reviewerId\": \"string\",\n \"reviewerName\": \"string\",\n \"reviewComment\": \"string\",\n \"causaId\": \"string\",\n \"causaRol\": \"string\",\n \"internalCauseId\": \"string\",\n \"taskId\": \"string\",\n \"taskTitle\": \"string\",\n \"updatedBy\": \"string\",\n \"teamId\": \"string\",\n \"teamName\": \"string\",\n \"sharedTeamIds\": [\n \"string\"\n ],\n \"ownerName\": \"string\"\n },\n \"html\": \"string\",\n \"rev\": 0,\n \"viewers\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"me\": true\n }\n ],\n \"comments\": [\n {\n \"id\": \"string\",\n \"author\": \"string\",\n \"body\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get drive file url", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"version\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "get-drive-file-url" ], "raw": "{{baseUrl}}/api/actions/drive/files/get-drive-file-url" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"name\": \"string\",\n \"contentBase64\": \"string\",\n \"mime\": \"string\",\n \"url\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get drive pickers", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {}\n ]\n}" }, "description": "Get drive pickers\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "get-drive-pickers" ], "raw": "{{baseUrl}}/api/actions/drive/files/get-drive-pickers" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"folders\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"causas\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"internalCases\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"tasks\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"members\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidador automation status", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "queries", "get-liquidador-automation-status" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/queries/get-liquidador-automation-status" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"familia\": \"string\",\n \"cierrePeriodoOrdinario\": {\n \"key\": \"string\",\n \"title\": \"string\",\n \"legalBasis\": \"string\",\n \"note\": \"string\",\n \"baseEvent\": \"string\",\n \"baseDate\": \"2026-01-31T12:00:00Z\",\n \"dueDate\": \"2026-01-31T12:00:00Z\",\n \"days\": 0,\n \"businessDays\": true,\n \"dayRule\": \"corridos\",\n \"dayRuleLabel\": \"string\",\n \"approx\": true,\n \"status\": \"cumplido\",\n \"doneEvent\": \"string\",\n \"doneDate\": \"2026-01-31T12:00:00Z\",\n \"daysLeft\": 0\n },\n \"nominaCreditosReconocidos\": {\n \"key\": \"string\",\n \"title\": \"string\",\n \"legalBasis\": \"string\",\n \"note\": \"string\",\n \"baseEvent\": \"string\",\n \"baseDate\": \"2026-01-31T12:00:00Z\",\n \"dueDate\": \"2026-01-31T12:00:00Z\",\n \"days\": 0,\n \"businessDays\": true,\n \"dayRule\": \"corridos\",\n \"dayRuleLabel\": \"string\",\n \"approx\": true,\n \"status\": \"cumplido\",\n \"doneEvent\": \"string\",\n \"doneDate\": \"2026-01-31T12:00:00Z\",\n \"daysLeft\": 0\n },\n \"necesitaAmpliacionONomina\": true,\n \"motivoAmpliacion\": \"string\",\n \"pendingCreditos\": 0,\n \"pendingObjeciones\": 0,\n \"pendingResoluciones\": 0,\n \"pendingNomina\": 0,\n \"pendingCompilado\": 0,\n \"pendingBienesSolicitud\": 0,\n \"pendingBienesActa\": 0,\n \"pendingBienesOficios\": 0,\n \"pendingBienesRendiciones\": 0,\n \"compiladoOrdinarioListo\": true\n }\n ],\n \"issues\": [\n {\n \"cbcId\": \"string\",\n \"rol\": \"string\",\n \"identifier\": \"string\",\n \"url\": \"string\",\n \"status\": \"string\",\n \"failedAreas\": [\n \"string\"\n ],\n \"lastError\": \"string\",\n \"lastFailedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"canManage\": true,\n \"isSuperAdmin\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidator bienes summary", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "queries", "get-liquidator-bienes-summary" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/queries/get-liquidator-bienes-summary" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"canManage\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidator credits portfolio status", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "queries", "get-liquidator-credits-portfolio-status" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/queries/get-liquidator-credits-portfolio-status" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causas\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"tipoProcedimiento\": \"string\",\n \"familia\": \"string\",\n \"cierrePeriodoOrdinario\": {\n \"key\": \"string\",\n \"title\": \"string\",\n \"legalBasis\": \"string\",\n \"note\": \"string\",\n \"baseEvent\": \"string\",\n \"baseDate\": \"2026-01-31T12:00:00Z\",\n \"dueDate\": \"2026-01-31T12:00:00Z\",\n \"days\": 0,\n \"businessDays\": true,\n \"dayRule\": \"corridos\",\n \"dayRuleLabel\": \"string\",\n \"approx\": true,\n \"status\": \"cumplido\",\n \"doneEvent\": \"string\",\n \"doneDate\": \"2026-01-31T12:00:00Z\",\n \"daysLeft\": 0\n },\n \"nominaCreditosReconocidos\": {\n \"key\": \"string\",\n \"title\": \"string\",\n \"legalBasis\": \"string\",\n \"note\": \"string\",\n \"baseEvent\": \"string\",\n \"baseDate\": \"2026-01-31T12:00:00Z\",\n \"dueDate\": \"2026-01-31T12:00:00Z\",\n \"days\": 0,\n \"businessDays\": true,\n \"dayRule\": \"corridos\",\n \"dayRuleLabel\": \"string\",\n \"approx\": true,\n \"status\": \"cumplido\",\n \"doneEvent\": \"string\",\n \"doneDate\": \"2026-01-31T12:00:00Z\",\n \"daysLeft\": 0\n },\n \"necesitaAmpliacionONomina\": true,\n \"motivoAmpliacion\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidator credits summary", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "queries", "get-liquidator-credits-summary" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/queries/get-liquidator-credits-summary" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"canManage\": true,\n \"causa\": {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"tribunal\": \"string\",\n \"source\": \"L\",\n \"documentId\": \"string\",\n \"causaId\": \"string\",\n \"tipoProcedimiento\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidator writing document url", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "queries", "get-liquidator-writing-document-url" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/queries/get-liquidator-writing-document-url" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"previewUrl\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidator writing draft text", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "queries", "get-liquidator-writing-draft-text" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/queries/get-liquidator-writing-draft-text" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"body\": \"string\",\n \"missingFields\": [\n \"string\"\n ],\n \"escrito\": {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"label\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get liquidator writing folios", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "queries", "get-liquidator-writing-folios" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/queries/get-liquidator-writing-folios" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"folios\": [\n {\n \"id\": \"string\",\n \"folio\": \"string\",\n \"tramite\": \"string\",\n \"descripcion\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"hasDoc\": true,\n \"docPath\": \"string\",\n \"selected\": true,\n \"isResolucion\": true\n }\n ],\n \"escrito\": {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"label\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List drive", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"view\": \"\",\n \"folderId\": \"\",\n \"teamId\": \"\",\n \"internalCauseId\": \"\",\n \"q\": \"\"\n }\n ]\n}" }, "description": "List drive\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "list-drive" ], "raw": "{{baseUrl}}/api/actions/drive/files/list-drive" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"folders\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"kind\": \"branch\",\n \"source\": \"string\",\n \"parentId\": \"string\",\n \"personal\": true,\n \"teamId\": \"string\",\n \"teamName\": \"string\",\n \"sharedTeamIds\": [\n \"string\"\n ],\n \"ownerName\": \"string\",\n \"deletedAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"files\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"kind\": \"FILE\",\n \"mime\": \"string\",\n \"size\": 0,\n \"version\": 0,\n \"personal\": true,\n \"folderId\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"deletedAt\": \"2026-01-31T12:00:00Z\",\n \"reviewStatus\": \"string\",\n \"reviewerId\": \"string\",\n \"reviewerName\": \"string\",\n \"reviewComment\": \"string\",\n \"causaId\": \"string\",\n \"causaRol\": \"string\",\n \"internalCauseId\": \"string\",\n \"taskId\": \"string\",\n \"taskTitle\": \"string\",\n \"updatedBy\": \"string\",\n \"teamId\": \"string\",\n \"teamName\": \"string\",\n \"sharedTeamIds\": [\n \"string\"\n ],\n \"ownerName\": \"string\",\n \"source\": \"string\",\n \"targetId\": \"string\",\n \"date\": \"string\",\n \"path\": \"string\",\n \"documentId\": \"string\"\n }\n ],\n \"breadcrumbs\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"usedBytes\": 0,\n \"quotaBytes\": 0,\n \"teams\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"member\": true\n }\n ],\n \"expedientes\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"rol\": \"string\",\n \"clientName\": \"string\",\n \"archived\": true,\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"documentCount\": 0\n }\n ],\n \"expediente\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"rol\": \"string\",\n \"canEdit\": true,\n \"readOnly\": true,\n \"relatedCauseId\": \"string\",\n \"folderId\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List drive templates", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {}\n ]\n}" }, "description": "List drive templates\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "templates", "list-drive-templates" ], "raw": "{{baseUrl}}/api/actions/drive/templates/list-drive-templates" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"templates\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"html\": \"string\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"variables\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List drive versions", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "List drive versions\n\nAuthentication: developer API key. Required scope: `documents:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "list-drive-versions" ], "raw": "{{baseUrl}}/api/actions/drive/files/list-drive-versions" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"versions\": [\n {\n \"version\": 0,\n \"name\": \"string\",\n \"size\": 0,\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"createdBy\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List liquidator writings", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "List liquidator writings\n\nAuthentication: developer API key. Required scope: `liquidaciones:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "queries", "list-liquidator-writings" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/queries/list-liquidator-writings" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"escritos\": [\n {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"string\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\",\n \"rol\": \"string\",\n \"nombre\": \"string\",\n \"tribunal\": \"string\",\n \"eventoFecha\": \"string\",\n \"eventoDetectedAt\": \"string\",\n \"eventoPayload\": {},\n \"jobState\": \"string\",\n \"jobError\": \"string\",\n \"portalPubId\": \"string\",\n \"taskStatus\": \"string\",\n \"taskDueDate\": \"string\",\n \"draftFiles\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\"\n }\n ],\n \"draftState\": \"string\",\n \"draftMissingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"contexto\": \"string\",\n \"sugerencia\": \"string\",\n \"opciones\": [\n {\n \"tipo\": \"liquidador\",\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"patrocinaEnCausa\": true,\n \"ultimoUso\": \"string\"\n }\n ],\n \"permiteNuevo\": true\n }\n ],\n \"generating\": true,\n \"compiled\": true,\n \"drafted\": true,\n \"filingChannels\": [\n \"string\"\n ],\n \"filings\": {\n \"\u003ckey\u003e\": {\n \"canal\": \"string\",\n \"jobId\": \"string\",\n \"state\": \"string\",\n \"status\": \"string\",\n \"error\": \"string\",\n \"folio\": \"string\",\n \"numeroIngreso\": \"string\"\n }\n },\n \"label\": \"string\",\n \"labelEn\": \"string\",\n \"pjudFilingEnabled\": true,\n \"publishes\": true\n }\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"tipoCounts\": {\n \"\u003ckey\u003e\": 0\n },\n \"limit\": 0,\n \"catalog\": [\n {\n \"tipo\": \"string\",\n \"label\": \"string\",\n \"labelEn\": \"string\",\n \"publishes\": true,\n \"drafted\": true,\n \"compiled\": true\n }\n ],\n \"canManage\": true,\n \"pjudFilingEnabled\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Prioritize liquidator bienes extraction", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "prioritize-liquidator-bienes-extraction" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/prioritize-liquidator-bienes-extraction" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"queued\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Add drive comment", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"body\": \"\"\n }\n ]\n}" }, "description": "Add drive comment\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "docs", "add-drive-comment" ], "raw": "{{baseUrl}}/api/actions/drive/docs/add-drive-comment" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create drive document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"scope\": \"\",\n \"folderId\": \"\",\n \"name\": \"\",\n \"html\": \"\",\n \"docxBase64\": \"\",\n \"templateId\": \"\",\n \"causaId\": \"\"\n }\n ]\n}" }, "description": "Create drive document\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "docs", "create-drive-document" ], "raw": "{{baseUrl}}/api/actions/drive/docs/create-drive-document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create drive folder", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": \"\",\n \"folderId\": \"\",\n \"confirm\": false\n }\n ]\n}" }, "description": "Create drive folder\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "create-drive-folder" ], "raw": "{{baseUrl}}/api/actions/drive/files/create-drive-folder" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Cross match deudor rut", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "cross-match-deudor-rut" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/cross-match-deudor-rut" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"linked\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Decide drive review", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"approve\": false,\n \"comment\": \"\"\n }\n ]\n}" }, "description": "Decide drive review\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "decide-drive-review" ], "raw": "{{baseUrl}}/api/actions/drive/files/decide-drive-review" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete drive template", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete drive template\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "templates", "delete-drive-template" ], "raw": "{{baseUrl}}/api/actions/drive/templates/delete-drive-template" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete liquidator credit", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete liquidator credit\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "delete-liquidator-credit" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/delete-liquidator-credit" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"deleted\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Dismiss liquidator writing", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Dismiss liquidator writing\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "mutations", "dismiss-liquidator-writing" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/mutations/dismiss-liquidator-writing" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"label\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract all for org", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"limitPerCausa\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "extract-all-for-org" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/extract-all-for-org" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"orgId\": \"string\",\n \"started\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract all for org", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"limitPerCausa\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "extract-all-for-org" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/extract-all-for-org" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"orgId\": \"string\",\n \"started\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract compilado content", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Extract compilado content\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "extract-compilado-content" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/extract-compilado-content" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"matched\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract credito objecion", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Extract credito objecion\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "extract-credito-objecion" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/extract-credito-objecion" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"matched\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract liquidator bienes acta", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "extract-liquidator-bienes-acta" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-acta" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"read\": 0,\n \"actasCreated\": 0,\n \"bienesCreated\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract liquidator bienes bases remate", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "extract-liquidator-bienes-bases-remate" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-bases-remate" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"read\": 0,\n \"created\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract liquidator bienes oficios", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "extract-liquidator-bienes-oficios" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-oficios" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"read\": 0,\n \"oficiosCreated\": 0,\n \"bienesCreated\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract liquidator bienes rendiciones", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "extract-liquidator-bienes-rendiciones" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-rendiciones" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"read\": 0,\n \"created\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract liquidator bienes solicitud", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "extract-liquidator-bienes-request" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/extract-liquidator-bienes-request" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"read\": 0,\n \"created\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract liquidator credits", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Extract liquidator credits\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "extract-liquidator-credits" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/extract-liquidator-credits" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"read\": 0,\n \"created\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract nomina content", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Extract nomina content\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "extract-nomina-content" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/extract-nomina-content" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"matched\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract pending for causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "extract-pending-for-cause" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/extract-pending-for-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"cbcId\": \"string\",\n \"rol\": \"string\",\n \"solicitudRead\": 0,\n \"solicitudCreated\": 0,\n \"actaRead\": 0,\n \"actaCreated\": 0,\n \"actaBienesCreated\": 0,\n \"oficioRead\": 0,\n \"oficioCreated\": 0,\n \"oficioBienesCreated\": 0,\n \"rendicionRead\": 0,\n \"rendicionCreated\": 0,\n \"basesRemateRead\": 0,\n \"basesRemateCreated\": 0,\n \"realizacionMatched\": 0,\n \"error\": \"string\",\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract pending for causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "extract-pending-for-cause" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/extract-pending-for-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"cbcId\": \"string\",\n \"rol\": \"string\",\n \"read\": 0,\n \"created\": 0,\n \"objecionesRead\": 0,\n \"objecionesMatched\": 0,\n \"nominaRead\": 0,\n \"nominaMatched\": 0,\n \"resolucionesRead\": 0,\n \"resolucionesMatched\": 0,\n \"compiladoRead\": 0,\n \"compiladoMatched\": 0,\n \"cierreOrdinarioRead\": 0,\n \"cierreOrdinarioMatched\": 0,\n \"error\": \"string\",\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Extract resolucion verificacion", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Extract resolucion verificacion\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "extract-resolucion-verificacion" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/extract-resolucion-verificacion" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"matched\": 0,\n \"warnings\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Generate liquidator writing draft", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "mutations", "generate-liquidator-writing-draft" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/mutations/generate-liquidator-writing-draft" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"queued\": true,\n \"alreadyRunning\": true,\n \"escrito\": {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"label\": \"string\",\n \"generating\": true\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Link drive file", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"taskId\": \"\"\n }\n ]\n}" }, "description": "Link drive file\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "link-drive-file" ], "raw": "{{baseUrl}}/api/actions/drive/files/link-drive-file" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Move drive item", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": \"\",\n \"folderId\": \"\",\n \"confirm\": false\n }\n ]\n}" }, "description": "Move drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "move-drive-item" ], "raw": "{{baseUrl}}/api/actions/drive/files/move-drive-item" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Ping drive document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Ping drive document\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "docs", "ping-drive-document" ], "raw": "{{baseUrl}}/api/actions/drive/docs/ping-drive-document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rev\": 0,\n \"viewers\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"me\": true\n }\n ],\n \"comments\": [\n {\n \"id\": \"string\",\n \"author\": \"string\",\n \"body\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Publish compilado creditos", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Publish compilado creditos\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "publish-compilado-creditos" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/publish-compilado-creditos" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"jobId\": \"string\",\n \"escrito\": {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"label\": \"string\"\n },\n \"skipped\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Publish liquidator writing", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Publish liquidator writing\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "mutations", "publish-liquidator-writing" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/mutations/publish-liquidator-writing" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"jobId\": \"string\",\n \"escrito\": {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"label\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Publish primera publicacion", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Publish primera publicacion\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "mutations", "publish-primera-publicacion" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/mutations/publish-primera-publicacion" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"resolucionJobId\": \"string\",\n \"antecedentesJobId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Purge drive item", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": \"\",\n \"folderId\": \"\",\n \"confirm\": false\n }\n ]\n}" }, "description": "Purge drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "purge-drive-item" ], "raw": "{{baseUrl}}/api/actions/drive/files/purge-drive-item" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Record liquidator bien disposition", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "record-liquidator-bien-disposition" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/record-liquidator-bien-disposition" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"bienId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Rename drive item", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": \"\",\n \"folderId\": \"\",\n \"confirm\": false\n }\n ]\n}" }, "description": "Rename drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "rename-drive-item" ], "raw": "{{baseUrl}}/api/actions/drive/files/rename-drive-item" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Request drive review", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"reviewerId\": \"\"\n }\n ]\n}" }, "description": "Request drive review\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "request-drive-review" ], "raw": "{{baseUrl}}/api/actions/drive/files/request-drive-review" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Request extraction", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Request extraction\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "request-extraction" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/request-extraction" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"queued\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Restore drive item", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": \"\",\n \"folderId\": \"\",\n \"confirm\": false\n }\n ]\n}" }, "description": "Restore drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "restore-drive-item" ], "raw": "{{baseUrl}}/api/actions/drive/files/restore-drive-item" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Restore drive version", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"version\": 0\n }\n ]\n}" }, "description": "Restore drive version\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "restore-drive-version" ], "raw": "{{baseUrl}}/api/actions/drive/files/restore-drive-version" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"version\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Review liquidator bien", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Review liquidator bien\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "review-liquidator-bien" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/review-liquidator-bien" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"state\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Review liquidator credit", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Review liquidator credit\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "review-liquidator-credit" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/review-liquidator-credit" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"state\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Review liquidator realization event", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "review-liquidator-realization-event" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/review-liquidator-realization-event" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"eventId\": \"string\",\n \"bienId\": \"string\",\n \"state\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Review liquidator rendicion", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Review liquidator rendicion\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "review-liquidator-rendicion" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/review-liquidator-rendicion" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"state\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Run cuenta provisoria causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cuentas-provisorias", "mutations", "run-cuenta-provisoria-cause" ], "raw": "{{baseUrl}}/api/actions/cuentas-provisorias/mutations/run-cuenta-provisoria-cause" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"taskId\": \"string\",\n \"alreadyQueued\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Run cuentas provisorias all", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"kind\": \"\",\n \"periodo\": \"\",\n \"dryRun\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "cuentas-provisorias", "mutations", "run-cuentas-provisorias-all" ], "raw": "{{baseUrl}}/api/actions/cuentas-provisorias/mutations/run-cuentas-provisorias-all" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"queued\": 0,\n \"kind\": \"string\",\n \"periodo\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save assistant message to drive", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\",\n \"name\": \"\",\n \"scope\": \"\",\n \"folderId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "assistant", "save-assistant-message-to-drive" ], "raw": "{{baseUrl}}/api/actions/drive/assistant/save-assistant-message-to-drive" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"caseLabel\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save drive document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"html\": \"\",\n \"rev\": 0,\n \"baseHtml\": \"\"\n }\n ]\n}" }, "description": "Save drive document\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "docs", "save-drive-document" ], "raw": "{{baseUrl}}/api/actions/drive/docs/save-drive-document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"stale\": true,\n \"rev\": 0,\n \"conflict\": true,\n \"theirs\": \"string\",\n \"mine\": \"string\",\n \"merged\": true,\n \"html\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save drive template", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"html\": \"\"\n }\n ]\n}" }, "description": "Save drive template\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "templates", "save-drive-template" ], "raw": "{{baseUrl}}/api/actions/drive/templates/save-drive-template" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save liquidator writing draft text", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "mutations", "save-liquidator-writing-draft-text" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/mutations/save-liquidator-writing-draft-text" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"artifact\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"kind\": \"string\",\n \"state\": \"DRAFT\",\n \"body\": \"string\",\n \"missingFields\": [\n {\n \"clave\": \"string\",\n \"pregunta\": \"string\",\n \"contexto\": \"string\",\n \"sugerencia\": \"string\",\n \"opciones\": [\n {\n \"tipo\": \"liquidador\",\n \"nombre\": \"string\",\n \"rut\": \"string\",\n \"patrocinaEnCausa\": true,\n \"ultimoUso\": \"string\"\n }\n ],\n \"permiteNuevo\": true\n }\n ],\n \"files\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"mimeType\": \"string\"\n }\n ],\n \"error\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Share drive item", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"id\": \"\",\n \"teamIds\": []\n }\n ]\n}" }, "description": "Share drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "share-drive-item" ], "raw": "{{baseUrl}}/api/actions/drive/files/share-drive-item" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"sharedTeamIds\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Sync liquidator bienes realizacion", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-bienes", "mutations", "sync-liquidator-bienes-realizacion" ], "raw": "{{baseUrl}}/api/actions/liquidator-bienes/mutations/sync-liquidator-bienes-realizacion" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"updated\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Trash drive item", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"scope\": \"\",\n \"folderId\": \"\",\n \"confirm\": false\n }\n ]\n}" }, "description": "Trash drive item\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "trash-drive-item" ], "raw": "{{baseUrl}}/api/actions/drive/files/trash-drive-item" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": null\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Update liquidator writing selection", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-writings", "mutations", "update-liquidator-writing-selection" ], "raw": "{{baseUrl}}/api/actions/liquidator-writings/mutations/update-liquidator-writing-selection" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"causaBcId\": \"string\",\n \"causaId\": \"string\",\n \"eventoId\": \"string\",\n \"tipo\": \"string\",\n \"state\": \"string\",\n \"dueAt\": \"2026-01-31T12:00:00Z\",\n \"taskId\": \"string\",\n \"draftArtifactId\": \"string\",\n \"docPath\": \"string\",\n \"fileName\": \"string\",\n \"selection\": [\n \"string\"\n ],\n \"publicationType\": \"string\",\n \"uploadJobId\": \"string\",\n \"error\": \"string\",\n \"label\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upload drive file", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"scope\": \"\",\n \"folderId\": \"\",\n \"fileId\": \"\",\n \"name\": \"\",\n \"contentBase64\": \"\"\n }\n ]\n}" }, "description": "Upload drive file\n\nAuthentication: developer API key. Required scope: `documents:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "drive", "files", "upload-drive-file" ], "raw": "{{baseUrl}}/api/actions/drive/files/upload-drive-file" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"version\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"documents:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upsert liquidator credit", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Upsert liquidator credit\n\nAuthentication: developer API key. Required scope: `liquidaciones:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "liquidator-credits", "mutations", "upsert-liquidator-credit" ], "raw": "{{baseUrl}}/api/actions/liquidator-credits/mutations/upsert-liquidator-credit" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"montoTotal\": 0,\n \"periodo\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"liquidaciones:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Documents and Drive" }, { "item": [ { "name": "Get case workflow", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\",\n \"internalCauseId\": \"\"\n }\n ]\n}" }, "description": "Get case workflow\n\nAuthentication: developer API key. Required scope: `workflows:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "get-case-workflow" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/get-case-workflow" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"runs\": [\n {\n \"id\": \"string\",\n \"workflow\": \"string\",\n \"status\": \"string\",\n \"pendingConfirmation\": true,\n \"stage\": \"string\",\n \"transition\": \"string\",\n \"transitionDays\": 0,\n \"stageStartedAt\": \"2026-01-31T12:00:00Z\",\n \"stageCount\": 0,\n \"stageIndex\": 0,\n \"events\": [\n {\n \"kind\": \"string\",\n \"message\": \"string\",\n \"reason\": \"string\",\n \"at\": \"2026-01-31T12:00:00Z\",\n \"by\": \"string\"\n }\n ]\n }\n ],\n \"workflows\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get workflow", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Get workflow\n\nAuthentication: developer API key. Required scope: `workflows:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "get-workflow" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/get-workflow" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"workflow\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"active\": true,\n \"stages\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"transition\": \"string\",\n \"transitionDays\": 0,\n \"actions\": [\n {\n \"id\": \"string\",\n \"kind\": \"ASSIGN_TASK\",\n \"config\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"assigneeIds\": [\n \"string\"\n ],\n \"reviewerId\": \"string\",\n \"durationDays\": 0,\n \"offsetDays\": 0,\n \"hour\": 0,\n \"inviteClient\": true,\n \"dueDays\": 0\n }\n }\n ]\n }\n ]\n },\n \"canEdit\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List workflows", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "List workflows\n\nAuthentication: developer API key. Required scope: `workflows:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "list-workflows" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/list-workflows" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"workflows\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"active\": true,\n \"stages\": 0,\n \"activeRuns\": 0\n }\n ],\n \"canEdit\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Attach workflow", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"workflowId\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"procedureKey\": \"\",\n \"replace\": false\n }\n ]\n}" }, "description": "Attach workflow\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "attach-workflow" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/attach-workflow" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Copy workflow", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Copy workflow\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "copy-workflow" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/copy-workflow" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete workflow", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete workflow\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "delete-workflow" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/delete-workflow" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete workflow action", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete workflow action\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "delete-workflow-action" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/delete-workflow-action" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete workflow stage", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete workflow stage\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "delete-workflow-stage" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/delete-workflow-stage" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Move workflow stage", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"dir\": 0\n }\n ]\n}" }, "description": "Move workflow stage\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "move-workflow-stage" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/move-workflow-stage" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save workflow", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"tags\": []\n }\n ]\n}" }, "description": "Save workflow\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "save-workflow" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/save-workflow" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save workflow action", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"stageId\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"config\": {\n \"title\": \"\",\n \"description\": \"\",\n \"assigneeIds\": [],\n \"reviewerId\": \"\",\n \"durationDays\": 0,\n \"offsetDays\": 0,\n \"hour\": 0,\n \"inviteClient\": false,\n \"dueDays\": 0\n }\n }\n ]\n}" }, "description": "Save workflow action\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "save-workflow-action" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/save-workflow-action" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save workflow stage", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"workflowId\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"transition\": \"\",\n \"transitionDays\": 0\n }\n ]\n}" }, "description": "Save workflow stage\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "save-workflow-stage" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/save-workflow-stage" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set workflow active", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"active\": false\n }\n ]\n}" }, "description": "Set workflow active\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "set-workflow-active" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/set-workflow-active" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Workflow run command", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"runId\": \"\",\n \"op\": \"\",\n \"stageId\": \"\"\n }\n ]\n}" }, "description": "Workflow run command\n\nAuthentication: developer API key. Required scope: `workflows:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "workflows", "workflows", "workflow-run-command" ], "raw": "{{baseUrl}}/api/actions/workflows/workflows/workflow-run-command" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"workflows:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Workflows" }, { "item": [ { "name": "Block chat user", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"userId\": \"\"\n }\n ]\n}" }, "description": "Block chat user\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "moderation", "block-chat-user" ], "raw": "{{baseUrl}}/api/actions/chat/moderation/block-chat-user" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"userId\": \"string\",\n \"blocked\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Edit chat message", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\",\n \"body\": \"\"\n }\n ]\n}" }, "description": "Edit chat message\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "messages", "edit-chat-message" ], "raw": "{{baseUrl}}/api/actions/chat/messages/edit-chat-message" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"messageId\": \"string\",\n \"body\": \"string\",\n \"edited\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get active call", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\"\n }\n ]\n}" }, "description": "Get active call\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "calls", "queries", "get-active-call" ], "raw": "{{baseUrl}}/api/actions/calls/queries/get-active-call" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"call\": {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"string\",\n \"state\": \"string\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0,\n \"startedByName\": \"string\",\n \"participants\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"identity\": \"string\",\n \"role\": \"HOST\",\n \"state\": \"string\",\n \"joinedAt\": \"2026-01-31T12:00:00Z\",\n \"leftAt\": \"2026-01-31T12:00:00Z\",\n \"guest\": true\n }\n ]\n },\n \"enabled\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get activity events", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"unreadOnly\": false,\n \"eventType\": \"\",\n \"limit\": 0\n }\n ]\n}" }, "description": "Get activity events\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "activity", "queries", "get-activity-events" ], "raw": "{{baseUrl}}/api/actions/activity/queries/get-activity-events" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"events\": [\n {\n \"id\": \"string\",\n \"eventType\": \"string\",\n \"targetKind\": \"string\",\n \"targetId\": \"string\",\n \"caseType\": \"string\",\n \"caseId\": \"string\",\n \"title\": \"string\",\n \"preview\": \"string\",\n \"occurredAt\": \"2026-01-31T12:00:00Z\",\n \"actorId\": \"string\",\n \"read\": true\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get case messages", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseType\": \"\",\n \"caseId\": \"\",\n \"body\": \"\",\n \"parentMessageId\": \"\",\n \"mentionedIds\": [],\n \"linkedKind\": \"\",\n \"linkedId\": \"\"\n }\n ]\n}" }, "description": "Get case messages\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "conversations", "queries", "get-case-messages" ], "raw": "{{baseUrl}}/api/actions/conversations/queries/get-case-messages" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"messages\": [\n {\n \"id\": \"string\",\n \"authorId\": \"string\",\n \"authorName\": \"string\",\n \"body\": \"string\",\n \"parentMessageId\": \"string\",\n \"mentionedIds\": [\n \"string\"\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"editedAt\": \"2026-01-31T12:00:00Z\",\n \"deleted\": true\n }\n ],\n \"caseType\": \"string\",\n \"caseId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get chat events", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\",\n \"after\": 0\n }\n ]\n}" }, "description": "Get chat events\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "queries", "get-chat-events" ], "raw": "{{baseUrl}}/api/actions/chat/queries/get-chat-events" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"events\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"payload\": {},\n \"sequence\": 0,\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get chat messages", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\",\n \"before\": 0\n }\n ]\n}" }, "description": "Get chat messages\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "messages", "get-chat-messages" ], "raw": "{{baseUrl}}/api/actions/chat/messages/get-chat-messages" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"members\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"image\": \"string\",\n \"role\": \"MEMBER\",\n \"lastRead\": 0\n }\n ],\n \"messages\": [\n {\n \"id\": \"string\",\n \"sequence\": 0,\n \"authorId\": \"string\",\n \"canEdit\": true,\n \"canDelete\": true,\n \"canPin\": true,\n \"authorName\": \"string\",\n \"body\": \"string\",\n \"parentId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"editedAt\": \"2026-01-31T12:00:00Z\",\n \"deleted\": true,\n \"starred\": true,\n \"pinnedAt\": \"2026-01-31T12:00:00Z\",\n \"forwardedFromId\": \"string\",\n \"reactions\": [\n {\n \"emoji\": \"string\",\n \"count\": 0,\n \"userIds\": [\n \"string\"\n ],\n \"mine\": true\n }\n ],\n \"mentionedIds\": [\n \"string\"\n ],\n \"linkPreview\": {\n \"url\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"image\": \"string\",\n \"siteName\": \"string\"\n },\n \"parentPreview\": {\n \"authorName\": \"string\",\n \"body\": \"string\"\n },\n \"attachments\": [\n {\n \"id\": \"string\",\n \"filename\": \"string\",\n \"mimeType\": \"string\",\n \"bytes\": 0,\n \"sha256\": \"string\",\n \"state\": \"string\",\n \"durationMs\": 0,\n \"url\": \"string\"\n }\n ]\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get chat presence", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\"\n }\n ]\n}" }, "description": "Get chat presence\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "presence", "get-chat-presence" ], "raw": "{{baseUrl}}/api/actions/chat/presence/get-chat-presence" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"online\": [\n \"string\"\n ],\n \"typing\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"members\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"image\": \"string\",\n \"role\": \"MEMBER\",\n \"lastRead\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get chat typing", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\"\n }\n ]\n}" }, "description": "Get chat typing\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "queries", "get-chat-typing" ], "raw": "{{baseUrl}}/api/actions/chat/queries/get-chat-typing" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"typing\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get meeting", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"meetingId\": \"\",\n \"joinCode\": \"\"\n }\n ]\n}" }, "description": "Get meeting\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "queries", "get-meeting" ], "raw": "{{baseUrl}}/api/actions/meetings/queries/get-meeting" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"isHost\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get meeting recording url", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"recordingId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "queries", "get-meeting-recording-url" ], "raw": "{{baseUrl}}/api/actions/meetings/queries/get-meeting-recording-url" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get notification preference", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003cconversationID\u003e\"\n ]\n}" }, "description": "Get notification preference\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "notifications", "get-notification-preference" ], "raw": "{{baseUrl}}/api/actions/chat/notifications/get-notification-preference" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"level\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get web push config", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "notifications", "get-web-push-config" ], "raw": "{{baseUrl}}/api/actions/chat/notifications/get-web-push-config" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"enabled\": true,\n \"vapidPublicKey\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List blocked chat users", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "moderation", "list-blocked-chat-users" ], "raw": "{{baseUrl}}/api/actions/chat/moderation/list-blocked-chat-users" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"users\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List call history", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\"\n }\n ]\n}" }, "description": "List call history\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "calls", "queries", "list-call-history" ], "raw": "{{baseUrl}}/api/actions/calls/queries/list-call-history" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"calls\": [\n {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"string\",\n \"state\": \"string\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0,\n \"startedByName\": \"string\",\n \"joinedCount\": 0,\n \"mine\": true\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List case message reports", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseType\": \"\",\n \"caseId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "conversations", "moderation", "list-case-message-reports" ], "raw": "{{baseUrl}}/api/actions/conversations/moderation/list-case-message-reports" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"reports\": [\n {\n \"id\": \"string\",\n \"messageId\": \"string\",\n \"reason\": \"string\",\n \"details\": \"string\",\n \"status\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"reportedUserId\": \"string\",\n \"reportedUserName\": \"string\",\n \"message\": \"string\",\n \"reporterId\": \"string\",\n \"reporterName\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List chat conversations", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"includeArchived\": false\n }\n ]\n}" }, "description": "List chat conversations\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "queries", "list-chat-conversations" ], "raw": "{{baseUrl}}/api/actions/chat/queries/list-chat-conversations" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversations\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"name\": \"string\",\n \"title\": \"string\",\n \"caseType\": \"string\",\n \"caseId\": \"string\",\n \"lastSequence\": 0,\n \"lastRead\": 0,\n \"unread\": 0,\n \"mentions\": 0,\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"archived\": true,\n \"memberCount\": 0,\n \"canModerate\": true,\n \"mutedUntil\": \"2026-01-31T12:00:00Z\",\n \"lastMessage\": {\n \"body\": \"string\",\n \"deleted\": true,\n \"authorName\": \"string\",\n \"authorId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"attachments\": 0,\n \"mine\": true\n }\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List chat members", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003cconversationID\u003e\"\n ]\n}" }, "description": "List chat members\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "members", "list-chat-members" ], "raw": "{{baseUrl}}/api/actions/chat/members/list-chat-members" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"members\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"image\": \"string\",\n \"role\": \"string\",\n \"joinedAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List chat pinned messages", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "queries", "list-chat-pinned-messages" ], "raw": "{{baseUrl}}/api/actions/chat/queries/list-chat-pinned-messages" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"messages\": [\n {\n \"id\": \"string\",\n \"sequence\": 0,\n \"authorName\": \"string\",\n \"body\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"pinnedAt\": \"2026-01-31T12:00:00Z\",\n \"pinnedByName\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List chat reports", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\"\n }\n ]\n}" }, "description": "List chat reports\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "moderation", "list-chat-reports" ], "raw": "{{baseUrl}}/api/actions/chat/moderation/list-chat-reports" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"reports\": [\n {\n \"id\": \"string\",\n \"messageId\": \"string\",\n \"reason\": \"string\",\n \"details\": \"string\",\n \"status\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"reportedUserId\": \"string\",\n \"reportedUserName\": \"string\",\n \"message\": \"string\",\n \"reporterId\": \"string\",\n \"reporterName\": \"string\"\n }\n ],\n \"attachmentReviews\": [\n {\n \"id\": \"string\",\n \"messageId\": \"string\",\n \"filename\": \"string\",\n \"mimeType\": \"string\",\n \"bytes\": 0,\n \"durationMs\": 0,\n \"message\": \"string\",\n \"authorName\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"url\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List chat starred messages", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "queries", "list-chat-starred-messages" ], "raw": "{{baseUrl}}/api/actions/chat/queries/list-chat-starred-messages" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"messages\": [\n {\n \"id\": \"string\",\n \"sequence\": 0,\n \"authorName\": \"string\",\n \"body\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"starredAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List meetings", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"scope\": \"\"\n }\n ]\n}" }, "description": "List meetings\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "queries", "list-meetings" ], "raw": "{{baseUrl}}/api/actions/meetings/queries/list-meetings" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"meetings\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"hostId\": \"string\",\n \"hostName\": \"string\",\n \"mine\": true,\n \"state\": \"string\",\n \"scheduledAt\": \"2026-01-31T12:00:00Z\",\n \"durationMin\": 0,\n \"joinCode\": \"string\",\n \"joinPath\": \"string\",\n \"lobbyEnabled\": true,\n \"allowGuests\": true,\n \"recordingEnabled\": true,\n \"conversationId\": \"string\",\n \"invites\": 0,\n \"recordings\": 0,\n \"liveCallId\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Report case message", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\",\n \"reason\": \"\",\n \"details\": \"\"\n }\n ]\n}" }, "description": "Report case message\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "conversations", "moderation", "report-case-message" ], "raw": "{{baseUrl}}/api/actions/conversations/moderation/report-case-message" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"reported\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Report chat message", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\",\n \"reason\": \"\",\n \"details\": \"\"\n }\n ]\n}" }, "description": "Report chat message\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "moderation", "report-chat-message" ], "raw": "{{baseUrl}}/api/actions/chat/moderation/report-chat-message" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"reported\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Search chat messages", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"query\": \"\",\n \"conversationId\": \"\",\n \"beforeMessageId\": \"\"\n }\n ]\n}" }, "description": "Search chat messages\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "messages", "search-chat-messages" ], "raw": "{{baseUrl}}/api/actions/chat/messages/search-chat-messages" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"query\": \"string\",\n \"results\": [\n {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"conversationType\": \"string\",\n \"conversationName\": \"string\",\n \"sequence\": 0,\n \"authorId\": \"string\",\n \"authorName\": \"string\",\n \"body\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Unblock chat user", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"userId\": \"\"\n }\n ]\n}" }, "description": "Unblock chat user\n\nAuthentication: developer API key. Required scope: `communications:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "moderation", "unblock-chat-user" ], "raw": "{{baseUrl}}/api/actions/chat/moderation/unblock-chat-user" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"userId\": \"string\",\n \"blocked\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Add chat member", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003cconversationID\u003e\",\n \"\u003cuserID\u003e\"\n ]\n}" }, "description": "Add chat member\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "members", "add-chat-member" ], "raw": "{{baseUrl}}/api/actions/chat/members/add-chat-member" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"added\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Cancel meeting", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"meetingId\": \"\"\n }\n ]\n}" }, "description": "Cancel meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "mutations", "cancel-meeting" ], "raw": "{{baseUrl}}/api/actions/meetings/mutations/cancel-meeting" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"meetingId\": \"string\",\n \"state\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create call guest invite", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"callId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "calls", "mutations", "create-call-guest-invite" ], "raw": "{{baseUrl}}/api/actions/calls/mutations/create-call-guest-invite" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"token\": \"string\",\n \"expiresAt\": \"2026-01-31T12:00:00Z\",\n \"path\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create case message", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"caseType\": \"\",\n \"caseId\": \"\",\n \"body\": \"\",\n \"parentMessageId\": \"\",\n \"mentionedIds\": [],\n \"linkedKind\": \"\",\n \"linkedId\": \"\"\n }\n ]\n}" }, "description": "Create case message\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "conversations", "mutations", "create-case-message" ], "raw": "{{baseUrl}}/api/actions/conversations/mutations/create-case-message" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create chat conversation", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"type\": \"\",\n \"name\": \"\",\n \"memberIds\": []\n }\n ]\n}" }, "description": "Create chat conversation\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "mutations", "create-chat-conversation" ], "raw": "{{baseUrl}}/api/actions/chat/mutations/create-chat-conversation" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create meeting", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"meetingId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduledAt\": \"\",\n \"durationMin\": 0,\n \"lobbyEnabled\": false,\n \"allowGuests\": false,\n \"recordingEnabled\": false,\n \"conversationId\": \"\",\n \"inviteUserIds\": [],\n \"inviteEmails\": []\n }\n ]\n}" }, "description": "Create meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "mutations", "create-meeting" ], "raw": "{{baseUrl}}/api/actions/meetings/mutations/create-meeting" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"meeting\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"hostId\": \"string\",\n \"conversationId\": \"string\",\n \"timezone\": \"string\",\n \"roomName\": \"string\",\n \"joinCode\": \"string\",\n \"state\": \"string\",\n \"scheduledAt\": \"2026-01-31T12:00:00Z\",\n \"lockedAt\": \"2026-01-31T12:00:00Z\",\n \"durationMin\": 0,\n \"lobbyEnabled\": true,\n \"allowGuests\": true,\n \"recordingEnabled\": true,\n \"admittedIdentities\": [\n \"string\"\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"joinPath\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Decline call", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"callId\": \"\",\n \"skipVoIP\": false\n }\n ]\n}" }, "description": "Decline call\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "calls", "mutations", "decline-call" ], "raw": "{{baseUrl}}/api/actions/calls/mutations/decline-call" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"call\": {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"string\",\n \"state\": \"string\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete chat message", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\"\n }\n ]\n}" }, "description": "Delete chat message\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "messages", "delete-chat-message" ], "raw": "{{baseUrl}}/api/actions/chat/messages/delete-chat-message" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"messageId\": \"string\",\n \"deleted\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Dismiss notice", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"key\": \"\"\n }\n ]\n}" }, "description": "Dismiss notice\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "notifications", "mutations", "dismiss-notice" ], "raw": "{{baseUrl}}/api/actions/notifications/mutations/dismiss-notice" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"success\": true\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "End call", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"callId\": \"\"\n }\n ]\n}" }, "description": "End call\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "calls", "mutations", "end-call" ], "raw": "{{baseUrl}}/api/actions/calls/mutations/end-call" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"call\": {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"string\",\n \"state\": \"string\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Forward chat message", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\",\n \"conversationIds\": []\n }\n ]\n}" }, "description": "Forward chat message\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "messages", "forward-chat-message" ], "raw": "{{baseUrl}}/api/actions/chat/messages/forward-chat-message" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"forwarded\": [\n {\n \"conversationId\": \"string\",\n \"id\": \"string\",\n \"sequence\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Join call", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"callId\": \"\"\n }\n ]\n}" }, "description": "Join call\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "calls", "mutations", "join-call" ], "raw": "{{baseUrl}}/api/actions/calls/mutations/join-call" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"token\": \"string\",\n \"roomName\": \"string\",\n \"identity\": \"string\",\n \"role\": \"string\",\n \"call\": {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"string\",\n \"state\": \"string\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Join meeting", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"meetingId\": \"\",\n \"joinCode\": \"\"\n }\n ]\n}" }, "description": "Join meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "mutations", "join-meeting" ], "raw": "{{baseUrl}}/api/actions/meetings/mutations/join-meeting" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"token\": \"string\",\n \"roomName\": \"string\",\n \"identity\": \"string\",\n \"role\": \"string\",\n \"call\": {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"string\",\n \"state\": \"string\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0\n },\n \"meeting\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"hostId\": \"string\",\n \"conversationId\": \"string\",\n \"timezone\": \"string\",\n \"roomName\": \"string\",\n \"joinCode\": \"string\",\n \"state\": \"string\",\n \"scheduledAt\": \"2026-01-31T12:00:00Z\",\n \"lockedAt\": \"2026-01-31T12:00:00Z\",\n \"durationMin\": 0,\n \"lobbyEnabled\": true,\n \"allowGuests\": true,\n \"recordingEnabled\": true,\n \"admittedIdentities\": [\n \"string\"\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"joinPath\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Leave chat conversation", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\"\n }\n ]\n}" }, "description": "Leave chat conversation\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "members", "leave-chat-conversation" ], "raw": "{{baseUrl}}/api/actions/chat/members/leave-chat-conversation" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"left\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Mark activity read", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"eventId\": \"\"\n }\n ]\n}" }, "description": "Mark activity read\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "activity", "mutations", "mark-activity-read" ], "raw": "{{baseUrl}}/api/actions/activity/mutations/mark-activity-read" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"eventId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Mark chat read", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\",\n \"sequence\": 0\n }\n ]\n}" }, "description": "Mark chat read\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "collaboration", "mark-chat-read" ], "raw": "{{baseUrl}}/api/actions/chat/collaboration/mark-chat-read" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"sequence\": 0,\n \"unchanged\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Mark notifications read", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"ids\": [],\n \"deliveryId\": \"\"\n }\n ]\n}" }, "description": "Mark notifications read\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "notifications", "mutations", "mark-notifications-read" ], "raw": "{{baseUrl}}/api/actions/notifications/mutations/mark-notifications-read" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"success\": true\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Meeting host action", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"meetingId\": \"\",\n \"op\": \"\",\n \"identity\": \"\",\n \"trackSid\": \"\"\n }\n ]\n}" }, "description": "Meeting host action\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "mutations", "meeting-host-action" ], "raw": "{{baseUrl}}/api/actions/meetings/mutations/meeting-host-action" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"meeting\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"hostId\": \"string\",\n \"conversationId\": \"string\",\n \"timezone\": \"string\",\n \"roomName\": \"string\",\n \"joinCode\": \"string\",\n \"state\": \"SCHEDULED\",\n \"scheduledAt\": \"2026-01-31T12:00:00Z\",\n \"lockedAt\": \"2026-01-31T12:00:00Z\",\n \"durationMin\": 0,\n \"lobbyEnabled\": true,\n \"allowGuests\": true,\n \"recordingEnabled\": true,\n \"admittedIdentities\": [\n \"string\"\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"joinPath\": \"string\"\n },\n \"hostName\": \"string\",\n \"call\": {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"AUDIO\",\n \"state\": \"RINGING\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0\n },\n \"participants\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"identity\": \"string\",\n \"role\": \"HOST\",\n \"state\": \"string\",\n \"joinedAt\": \"2026-01-31T12:00:00Z\",\n \"leftAt\": \"2026-01-31T12:00:00Z\",\n \"guest\": true\n }\n ],\n \"waiting\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"identity\": \"string\",\n \"role\": \"HOST\",\n \"state\": \"string\",\n \"joinedAt\": \"2026-01-31T12:00:00Z\",\n \"leftAt\": \"2026-01-31T12:00:00Z\",\n \"guest\": true\n }\n ],\n \"invites\": [\n {\n \"userId\": \"string\",\n \"email\": \"string\",\n \"name\": \"string\",\n \"state\": \"PENDING\",\n \"sentAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"recordings\": [\n {\n \"id\": \"string\",\n \"meetingId\": \"string\",\n \"callId\": \"string\",\n \"startedById\": \"string\",\n \"bytes\": 0,\n \"durationMs\": 0,\n \"state\": \"RECORDING\",\n \"error\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"expiresAt\": \"2026-01-31T12:00:00Z\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Meeting recording", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"meetingId\": \"\",\n \"op\": \"\",\n \"audioOnly\": false\n }\n ]\n}" }, "description": "Meeting recording\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "mutations", "meeting-recording" ], "raw": "{{baseUrl}}/api/actions/meetings/mutations/meeting-recording" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"meeting\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"hostId\": \"string\",\n \"conversationId\": \"string\",\n \"timezone\": \"string\",\n \"roomName\": \"string\",\n \"joinCode\": \"string\",\n \"state\": \"SCHEDULED\",\n \"scheduledAt\": \"2026-01-31T12:00:00Z\",\n \"lockedAt\": \"2026-01-31T12:00:00Z\",\n \"durationMin\": 0,\n \"lobbyEnabled\": true,\n \"allowGuests\": true,\n \"recordingEnabled\": true,\n \"admittedIdentities\": [\n \"string\"\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"joinPath\": \"string\"\n },\n \"hostName\": \"string\",\n \"call\": {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"AUDIO\",\n \"state\": \"RINGING\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0\n },\n \"participants\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"identity\": \"string\",\n \"role\": \"HOST\",\n \"state\": \"string\",\n \"joinedAt\": \"2026-01-31T12:00:00Z\",\n \"leftAt\": \"2026-01-31T12:00:00Z\",\n \"guest\": true\n }\n ],\n \"waiting\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"identity\": \"string\",\n \"role\": \"HOST\",\n \"state\": \"string\",\n \"joinedAt\": \"2026-01-31T12:00:00Z\",\n \"leftAt\": \"2026-01-31T12:00:00Z\",\n \"guest\": true\n }\n ],\n \"invites\": [\n {\n \"userId\": \"string\",\n \"email\": \"string\",\n \"name\": \"string\",\n \"state\": \"PENDING\",\n \"sentAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"recordings\": [\n {\n \"id\": \"string\",\n \"meetingId\": \"string\",\n \"callId\": \"string\",\n \"startedById\": \"string\",\n \"bytes\": 0,\n \"durationMs\": 0,\n \"state\": \"RECORDING\",\n \"error\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"expiresAt\": \"2026-01-31T12:00:00Z\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Pin chat message", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\",\n \"active\": false\n }\n ]\n}" }, "description": "Pin chat message\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "collaboration", "pin-chat-message" ], "raw": "{{baseUrl}}/api/actions/chat/collaboration/pin-chat-message" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"messageId\": \"string\",\n \"active\": true,\n \"conversationId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Remove chat member", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003ccid\u003e\",\n \"\u003cuid\u003e\",\n \"\u003crole\u003e\"\n ]\n}" }, "description": "Remove chat member\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "members", "remove-chat-member" ], "raw": "{{baseUrl}}/api/actions/chat/members/remove-chat-member" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"updated\": true,\n \"removed\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Rename chat conversation", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\",\n \"name\": \"\"\n }\n ]\n}" }, "description": "Rename chat conversation\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "mutations", "rename-chat-conversation" ], "raw": "{{baseUrl}}/api/actions/chat/mutations/rename-chat-conversation" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"name\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Review case message report", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"reportId\": \"\",\n \"decision\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "conversations", "moderation", "review-case-message-report" ], "raw": "{{baseUrl}}/api/actions/conversations/moderation/review-case-message-report" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"reportId\": \"string\",\n \"status\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Review chat report", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"reportId\": \"\",\n \"attachmentId\": \"\",\n \"decision\": \"\"\n }\n ]\n}" }, "description": "Review chat report\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "moderation", "review-chat-report" ], "raw": "{{baseUrl}}/api/actions/chat/moderation/review-chat-report" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"attachmentId\": \"string\",\n \"state\": \"string\",\n \"reportId\": \"string\",\n \"status\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Send chat message", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"body\": \"Hello\",\n \"clientMessageId\": \"\u003cCLIENT_MESSAGE_ID\u003e\",\n \"conversationId\": \"\u003cCONVERSATION_ID\u003e\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "messages", "send-chat-message" ], "raw": "{{baseUrl}}/api/actions/chat/messages/send-chat-message" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"sequence\": 0,\n \"deduplicated\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Send chat typing", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\",\n \"active\": false\n }\n ]\n}" }, "description": "Send chat typing\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "queries", "send-chat-typing" ], "raw": "{{baseUrl}}/api/actions/chat/queries/send-chat-typing" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set chat conversation archived", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\",\n \"archived\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "mutations", "set-chat-conversation-archived" ], "raw": "{{baseUrl}}/api/actions/chat/mutations/set-chat-conversation-archived" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"archived\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set chat conversation muted", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\",\n \"hours\": 0\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "collaboration", "set-chat-conversation-muted" ], "raw": "{{baseUrl}}/api/actions/chat/collaboration/set-chat-conversation-muted" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"mutedUntil\": \"2026-01-31T12:00:00Z\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set chat member role", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003ccid\u003e\",\n \"\u003cuid\u003e\",\n \"\u003crole\u003e\"\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "members", "set-chat-member-role" ], "raw": "{{baseUrl}}/api/actions/chat/members/set-chat-member-role" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"updated\": true,\n \"removed\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set notification preference", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n \"\u003cconversationID\u003e\",\n \"\u003clevel\u003e\"\n ]\n}" }, "description": "Set notification preference\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "notifications", "set-notification-preference" ], "raw": "{{baseUrl}}/api/actions/chat/notifications/set-notification-preference" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"conversationId\": \"string\",\n \"level\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Start call", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"conversationId\": \"\",\n \"kind\": \"\"\n }\n ]\n}" }, "description": "Start call\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "calls", "mutations", "start-call" ], "raw": "{{baseUrl}}/api/actions/calls/mutations/start-call" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"call\": {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"string\",\n \"state\": \"string\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0\n },\n \"existing\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Start meeting", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"meetingId\": \"\"\n }\n ]\n}" }, "description": "Start meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "mutations", "start-meeting" ], "raw": "{{baseUrl}}/api/actions/meetings/mutations/start-meeting" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"token\": \"string\",\n \"roomName\": \"string\",\n \"identity\": \"string\",\n \"role\": \"string\",\n \"call\": {\n \"id\": \"string\",\n \"conversationId\": \"string\",\n \"meetingId\": \"string\",\n \"roomName\": \"string\",\n \"kind\": \"string\",\n \"state\": \"string\",\n \"startedById\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\",\n \"answeredAt\": \"2026-01-31T12:00:00Z\",\n \"endedAt\": \"2026-01-31T12:00:00Z\",\n \"endReason\": \"string\",\n \"durationMs\": 0\n },\n \"meeting\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"hostId\": \"string\",\n \"conversationId\": \"string\",\n \"timezone\": \"string\",\n \"roomName\": \"string\",\n \"joinCode\": \"string\",\n \"state\": \"string\",\n \"scheduledAt\": \"2026-01-31T12:00:00Z\",\n \"lockedAt\": \"2026-01-31T12:00:00Z\",\n \"durationMin\": 0,\n \"lobbyEnabled\": true,\n \"allowGuests\": true,\n \"recordingEnabled\": true,\n \"admittedIdentities\": [\n \"string\"\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"joinPath\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Toggle chat reaction", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\",\n \"emoji\": \"\",\n \"active\": false\n }\n ]\n}" }, "description": "Toggle chat reaction\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "collaboration", "toggle-chat-reaction" ], "raw": "{{baseUrl}}/api/actions/chat/collaboration/toggle-chat-reaction" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"messageId\": \"string\",\n \"emoji\": \"string\",\n \"active\": true,\n \"conversationId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Toggle chat star", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"messageId\": \"\",\n \"active\": false\n }\n ]\n}" }, "description": "Toggle chat star\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "chat", "collaboration", "toggle-chat-star" ], "raw": "{{baseUrl}}/api/actions/chat/collaboration/toggle-chat-star" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"messageId\": \"string\",\n \"active\": true,\n \"conversationId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Update meeting", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"meetingId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"scheduledAt\": \"\",\n \"durationMin\": 0,\n \"lobbyEnabled\": false,\n \"allowGuests\": false,\n \"recordingEnabled\": false,\n \"conversationId\": \"\",\n \"inviteUserIds\": [],\n \"inviteEmails\": []\n }\n ]\n}" }, "description": "Update meeting\n\nAuthentication: developer API key. Required scope: `communications:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "meetings", "mutations", "update-meeting" ], "raw": "{{baseUrl}}/api/actions/meetings/mutations/update-meeting" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"meeting\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"hostId\": \"string\",\n \"conversationId\": \"string\",\n \"timezone\": \"string\",\n \"roomName\": \"string\",\n \"joinCode\": \"string\",\n \"state\": \"string\",\n \"scheduledAt\": \"2026-01-31T12:00:00Z\",\n \"lockedAt\": \"2026-01-31T12:00:00Z\",\n \"durationMin\": 0,\n \"lobbyEnabled\": true,\n \"allowGuests\": true,\n \"recordingEnabled\": true,\n \"admittedIdentities\": [\n \"string\"\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"joinPath\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"communications:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Communications" }, { "item": [ { "name": "Get billing report", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n}" }, "description": "Get billing report\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "advanced", "get-billing-report" ], "raw": "{{baseUrl}}/api/actions/reports/advanced/get-billing-report" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"from\": \"2026-01-31\",\n \"to\": \"2026-01-31\",\n \"totals\": [\n {\n \"currency\": \"string\",\n \"collected\": 0,\n \"tax\": 0,\n \"net\": 0,\n \"pending\": 0,\n \"overdue\": 0\n }\n ],\n \"byMonth\": [\n {\n \"month\": \"string\",\n \"currency\": \"string\",\n \"billed\": 0,\n \"collected\": 0\n }\n ],\n \"byStatus\": [\n {\n \"status\": \"DRAFT\",\n \"currency\": \"string\",\n \"count\": 0,\n \"total\": 0\n }\n ],\n \"topClients\": [\n {\n \"client\": \"string\",\n \"currency\": \"string\",\n \"billed\": 0,\n \"collected\": 0\n }\n ],\n \"issued\": [\n {\n \"currency\": \"string\",\n \"notes\": 0,\n \"clients\": 0,\n \"billed\": 0\n }\n ],\n \"byKind\": [\n {\n \"kind\": \"HOURS\",\n \"currency\": \"string\",\n \"amount\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get causes pending report", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"competence\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"includeArchived\": false,\n \"bucket\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "queries", "get-causes-pending-report" ], "raw": "{{baseUrl}}/api/actions/reports/queries/get-causes-pending-report" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"total\": 0,\n \"order\": [\n \"string\"\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n },\n \"docErrorTotal\": 0,\n \"suspectFechaIngreso\": 0,\n \"historia\": {\n \"withDocErrors\": 0,\n \"causasWithDocErrors\": 0,\n \"docErrorTotal\": 0\n },\n \"bucket\": \"string\",\n \"rows\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"status\": \"string\",\n \"errorCategory\": \"string\",\n \"lastUpdate\": \"2026-01-31T12:00:00Z\",\n \"lastChangeAt\": \"2026-01-31T12:00:00Z\",\n \"docErrorCount\": 0\n }\n ],\n \"rowsTruncated\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get causes state report", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"competence\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"includeArchived\": false,\n \"bucket\": \"\"\n }\n ]\n}" }, "description": "Causa state report.\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "queries", "get-causes-state-report" ], "raw": "{{baseUrl}}/api/actions/reports/queries/get-causes-state-report" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"total\": 0,\n \"byCompetence\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byEstado\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byEstadoOtros\": 0,\n \"byEtapa\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byEtapaOtros\": 0,\n \"byTipoProcedimiento\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byTipoProcedimientoOtros\": 0,\n \"byCorte\": [\n {\n \"id\": 0,\n \"count\": 0\n }\n ],\n \"byTribunal\": [\n {\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"count\": 0\n }\n ],\n \"ageBuckets\": {\n \"order\": [\n \"string\"\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n }\n },\n \"idleBuckets\": {\n \"order\": [\n \"string\"\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n }\n },\n \"ageCounts\": null,\n \"idleCounts\": null\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get causes timing report", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"competence\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"includeArchived\": false,\n \"bucket\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "queries", "get-causes-timing-report" ], "raw": "{{baseUrl}}/api/actions/reports/queries/get-causes-timing-report" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"sample\": 0,\n \"withMovements\": 0,\n \"withoutMovements\": 0,\n \"avgIdleDays\": 0,\n \"medianIdleDays\": 0,\n \"p90IdleDays\": 0,\n \"avgDwnc\": 0,\n \"medianDwnc\": 0,\n \"resolutionSample\": 0,\n \"avgResolutionDays\": 0,\n \"medianResolutionDays\": 0,\n \"p90ResolutionDays\": 0,\n \"avgAgeDays\": 0,\n \"medianAgeDays\": 0,\n \"idleBuckets\": {\n \"order\": [\n \"string\"\n ],\n \"counts\": {\n \"\u003ckey\u003e\": 0\n }\n },\n \"slowestTribunals\": [\n {\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"causas\": 0,\n \"sample\": 0,\n \"avgResolutionDays\": 0,\n \"medianResolutionDays\": 0\n }\n ],\n \"mostIdle\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"idleDays\": 0,\n \"lastChangeAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"idleCounts\": null\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get causes workload report", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"competence\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"includeArchived\": false,\n \"bucket\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "queries", "get-causes-workload-report" ], "raw": "{{baseUrl}}/api/actions/reports/queries/get-causes-workload-report" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"canViewAllTeams\": true,\n \"total\": 0,\n \"withoutResponsible\": 0,\n \"untagged\": 0,\n \"tasksWithoutCausa\": 0,\n \"byUser\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"causas\": 0,\n \"causasErrored\": 0,\n \"causasIdle30d\": 0,\n \"tasksOpen\": 0,\n \"tasksPending\": 0,\n \"tasksInProgress\": 0,\n \"tasksHighPriority\": 0,\n \"tasksOverdue\": 0,\n \"tasksDueNext7d\": 0\n }\n ],\n \"byTeam\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"causas\": 0,\n \"causasErrored\": 0,\n \"causasIdle30d\": 0,\n \"tasksOpen\": 0,\n \"tasksPending\": 0,\n \"tasksInProgress\": 0,\n \"tasksHighPriority\": 0,\n \"tasksOverdue\": 0,\n \"tasksDueNext7d\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get internal report", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n}" }, "description": "Get internal report\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "advanced", "get-internal-report" ], "raw": "{{baseUrl}}/api/actions/reports/advanced/get-internal-report" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"from\": \"string\",\n \"to\": \"string\",\n \"cases\": {\n \"active\": 0,\n \"stopped\": 0,\n \"closed\": 0,\n \"total\": 0\n },\n \"byState\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"tasks\": {\n \"onTime\": 0,\n \"late\": 0,\n \"overdue\": 0,\n \"open\": 0\n },\n \"people\": [\n {\n \"userId\": \"string\",\n \"name\": \"string\",\n \"cases\": 0,\n \"onTime\": 0,\n \"late\": 0,\n \"overdue\": 0,\n \"open\": 0,\n \"minutes\": 0,\n \"billableMinutes\": 0\n }\n ],\n \"hoursByUser\": [\n {\n \"id\": \"string\",\n \"label\": \"string\",\n \"minutes\": 0,\n \"billableMinutes\": 0\n }\n ],\n \"hoursByClient\": [\n {\n \"id\": \"string\",\n \"label\": \"string\",\n \"minutes\": 0,\n \"billableMinutes\": 0\n }\n ],\n \"totalMinutes\": 0,\n \"hoursAll\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get judicial report", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"clientId\": \"\",\n \"competence\": \"\",\n \"tribunalId\": \"\",\n \"lawyerId\": \"\",\n \"estado\": \"\",\n \"etapa\": \"\",\n \"attributeId\": \"\",\n \"attributeValue\": \"\",\n \"includeArchived\": false\n }\n ]\n}" }, "description": "Get judicial report\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "advanced", "get-judicial-report" ], "raw": "{{baseUrl}}/api/actions/reports/advanced/get-judicial-report" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"total\": 0,\n \"byEstado\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byEtapa\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"byCompetence\": [\n {\n \"label\": \"string\",\n \"count\": 0\n }\n ],\n \"topTribunals\": [\n {\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"count\": 0\n }\n ],\n \"activity\": [\n {\n \"key\": \"string\",\n \"count\": 0,\n \"percent\": 0\n }\n ],\n \"rows\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"cuaderno\": \"string\",\n \"materia\": \"string\",\n \"clients\": \"string\",\n \"estado\": \"string\",\n \"lastMovement\": \"2026-01-31T12:00:00Z\",\n \"summary\": \"string\"\n }\n ],\n \"rowsTruncated\": true,\n \"options\": {\n \"clients\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"lawyers\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ],\n \"attributes\": [\n {\n \"id\": \"string\",\n \"label\": \"string\"\n }\n ]\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List report dashboards", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "List report dashboards\n\nAuthentication: developer API key. Required scope: `reports:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "dashboards", "list-report-dashboards" ], "raw": "{{baseUrl}}/api/actions/reports/dashboards/list-report-dashboards" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"dashboards\": [\n {\n \"id\": \"string\",\n \"ownerId\": \"string\",\n \"ownerName\": \"string\",\n \"name\": \"string\",\n \"shared\": true,\n \"widgets\": [\n {\n \"type\": \"string\",\n \"size\": \"string\",\n \"filters\": {\n \"\u003ckey\u003e\": \"string\"\n }\n }\n ],\n \"canEdit\": true,\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"canBilling\": true,\n \"widgetTypes\": [\n \"string\"\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete report dashboard", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete report dashboard\n\nAuthentication: developer API key. Required scope: `reports:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "dashboards", "delete-report-dashboard" ], "raw": "{{baseUrl}}/api/actions/reports/dashboards/delete-report-dashboard" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save report dashboard", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"ownerId\": \"\",\n \"ownerName\": \"\",\n \"name\": \"\",\n \"shared\": false,\n \"widgets\": [],\n \"canEdit\": false,\n \"updatedAt\": \"2026-01-01T00:00:00Z\"\n }\n ]\n}" }, "description": "Save report dashboard\n\nAuthentication: developer API key. Required scope: `reports:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "reports", "dashboards", "save-report-dashboard" ], "raw": "{{baseUrl}}/api/actions/reports/dashboards/save-report-dashboard" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reports:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Reports" }, { "item": [ { "name": "List import candidates", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"sourceId\": \"\",\n \"status\": \"\",\n \"institucion\": \"\",\n \"query\": \"\",\n \"competence\": \"\",\n \"estado\": \"\",\n \"filedFrom\": \"\",\n \"filedTo\": \"\",\n \"sort\": \"\",\n \"limit\": 0\n }\n ]\n}" }, "description": "List import candidates\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "list-import-candidates" ], "raw": "{{baseUrl}}/api/actions/import/assistant/list-import-candidates" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"items\": [\n {\n \"id\": \"string\",\n \"competence\": \"string\",\n \"rol\": \"string\",\n \"court\": \"string\",\n \"caratulado\": \"string\",\n \"fechaIngreso\": \"string\",\n \"estado\": \"string\",\n \"institucion\": \"string\",\n \"status\": \"string\",\n \"skipReason\": \"string\",\n \"causaId\": \"string\",\n \"firstSeenAt\": \"2026-01-31T12:00:00Z\",\n \"notifiedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"counts\": {\n \"NEW\": 0,\n \"IMPORTED\": 0,\n \"DISMISSED\": 0,\n \"SKIPPED\": 0,\n \"NOTIFIED\": 0\n },\n \"facets\": {\n \"competences\": [\n {\n \"value\": \"string\",\n \"count\": 0\n }\n ],\n \"estados\": [\n {\n \"value\": \"string\",\n \"count\": 0\n }\n ]\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List import sources", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "List import sources\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "list-import-sources" ], "raw": "{{baseUrl}}/api/actions/import/assistant/list-import-sources" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"sources\": [\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"label\": \"string\",\n \"clientId\": \"string\",\n \"subdomain\": \"string\",\n \"authMode\": \"string\",\n \"login\": \"string\",\n \"dailyCheck\": true,\n \"dailyPaused\": true,\n \"lastRunAt\": \"2026-01-31T12:00:00Z\",\n \"lastRun\": {\n \"state\": \"string\",\n \"error\": \"string\",\n \"stats\": \"string\",\n \"startedAt\": \"2026-01-31T12:00:00Z\"\n },\n \"organizations\": [\n {\n \"id\": \"string\",\n \"value\": \"string\",\n \"name\": \"string\",\n \"follow\": true\n }\n ]\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List watched ruts", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"watchId\": \"\",\n \"competence\": \"\",\n \"onlyUnfollowed\": false,\n \"estado\": \"\",\n \"offset\": 0,\n \"limit\": 0\n }\n ]\n}" }, "description": "List watched ruts\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tracking", "rut-monitor", "list-watched-ruts" ], "raw": "{{baseUrl}}/api/actions/tracking/rut-monitor/list-watched-ruts" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ruts\": [\n {\n \"id\": \"string\",\n \"rut\": \"string\",\n \"label\": \"string\",\n \"name\": \"string\",\n \"corteId\": 0,\n \"active\": true,\n \"lastMatchAt\": \"2026-01-31T12:00:00Z\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"matches\": 0,\n \"followed\": 0,\n \"scanState\": \"string\",\n \"lastScannedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"matches\": [\n {\n \"id\": \"string\",\n \"watchId\": \"string\",\n \"rut\": \"string\",\n \"competence\": \"string\",\n \"rol\": \"string\",\n \"court\": \"string\",\n \"caratulado\": \"string\",\n \"fechaIng\": \"2026-01-31T12:00:00Z\",\n \"participant\": \"string\",\n \"estado\": \"string\",\n \"causaId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"matchTotal\": 0,\n \"competenceCounts\": {\n \"\u003ckey\u003e\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Test import connection", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"label\": \"\",\n \"clientId\": \"\",\n \"subdomain\": \"\",\n \"authMode\": \"\",\n \"login\": \"\",\n \"secret\": \"\"\n }\n ]\n}" }, "description": "Test import connection\n\nAuthentication: developer API key. Required scope: `integrations:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "test-import-connection" ], "raw": "{{baseUrl}}/api/actions/import/assistant/test-import-connection" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true,\n \"error\": \"string\",\n \"cases\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Add watched rut", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"rut\": \"\",\n \"label\": \"\",\n \"corteId\": 0\n }\n ]\n}" }, "description": "Add watched rut\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tracking", "rut-monitor", "add-watched-rut" ], "raw": "{{baseUrl}}/api/actions/tracking/rut-monitor/add-watched-rut" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create import source", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"kind\": \"\",\n \"label\": \"\",\n \"clientId\": \"\",\n \"subdomain\": \"\",\n \"authMode\": \"\",\n \"login\": \"\",\n \"secret\": \"\"\n }\n ]\n}" }, "description": "Create import source\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "create-import-source" ], "raw": "{{baseUrl}}/api/actions/import/assistant/create-import-source" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"existed\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete import source", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"sourceId\": \"\"\n }\n ]\n}" }, "description": "Delete import source\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "delete-import-source" ], "raw": "{{baseUrl}}/api/actions/import/assistant/delete-import-source" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Dismiss import candidates", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"ids\": [],\n \"restore\": false\n }\n ]\n}" }, "description": "Dismiss import candidates\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "dismiss-import-candidates" ], "raw": "{{baseUrl}}/api/actions/import/assistant/dismiss-import-candidates" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"updated\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Follow rut match", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"ids\": [],\n \"watchId\": \"\",\n \"all\": false\n }\n ]\n}" }, "description": "Follow rut match\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tracking", "rut-monitor", "follow-rut-match" ], "raw": "{{baseUrl}}/api/actions/tracking/rut-monitor/follow-rut-match" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"causaId\": \"string\",\n \"followed\": 0,\n \"failed\": 0,\n \"failedIds\": [\n \"string\"\n ],\n \"lastError\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Import candidates", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"ids\": [],\n \"teamIds\": []\n }\n ]\n}" }, "description": "Import candidates\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "import-candidates" ], "raw": "{{baseUrl}}/api/actions/import/assistant/import-candidates" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"result\": {\n \"\u003ckey\u003e\": 0\n },\n \"failures\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"error\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Refresh import organizations", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"sourceId\": \"\"\n }\n ]\n}" }, "description": "Refresh import organizations\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "refresh-import-organizations" ], "raw": "{{baseUrl}}/api/actions/import/assistant/refresh-import-organizations" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"count\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Remove watched rut", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Remove watched rut\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tracking", "rut-monitor", "remove-watched-rut" ], "raw": "{{baseUrl}}/api/actions/tracking/rut-monitor/remove-watched-rut" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Run import", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"sourceId\": \"\",\n \"organizations\": []\n }\n ]\n}" }, "description": "Run import\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "run-import" ], "raw": "{{baseUrl}}/api/actions/import/assistant/run-import" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"runId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set import daily paused", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"sourceId\": \"\",\n \"paused\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "set-import-daily-paused" ], "raw": "{{baseUrl}}/api/actions/import/assistant/set-import-daily-paused" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true,\n \"paused\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set import organization follow", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"organizationId\": \"\",\n \"follow\": false\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "set-import-organization-follow" ], "raw": "{{baseUrl}}/api/actions/import/assistant/set-import-organization-follow" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Upload import spreadsheet", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"filename\": \"\",\n \"label\": \"\",\n \"contentBase64\": \"\"\n }\n ]\n}" }, "description": "Upload import spreadsheet\n\nAuthentication: developer API key. Required scope: `integrations:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "import", "assistant", "upload-import-spreadsheet" ], "raw": "{{baseUrl}}/api/actions/import/assistant/upload-import-spreadsheet" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\",\n \"rows\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"integrations:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Integrations" }, { "item": [ { "name": "List an endpoint's deliveries", "request": { "description": "List an endpoint's deliveries\n\nAuthentication: developer API key with `webhooks:read` scope. Newest first, kept for 30 days.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "developer", "webhooks", "deliveries" ], "query": [ { "description": "Endpoint id.", "disabled": false, "key": "endpointId", "value": "" }, { "description": "Filter by status.", "disabled": true, "key": "status", "value": "" }, { "description": "Up to 100 (default 50).", "disabled": true, "key": "limit", "value": "" }, { "description": "RFC 3339 cursor: deliveries created before this time.", "disabled": true, "key": "before", "value": "" } ], "raw": "{{baseUrl}}/api/developer/webhooks/deliveries?endpointId=" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"endpointId\": \"string\",\n \"count\": 0,\n \"items\": [\n {\n \"id\": \"string\",\n \"endpointId\": \"string\",\n \"eventId\": \"string\",\n \"eventType\": \"string\",\n \"status\": \"PENDING\",\n \"attempts\": 0,\n \"lastStatusCode\": 0,\n \"lastError\": \"string\",\n \"lastDurationMs\": 0,\n \"nextAttemptAt\": \"2026-01-31T12:00:00Z\",\n \"deliveredAt\": \"2026-01-31T12:00:00Z\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"payload\": {\n \"id\": \"string\",\n \"type\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"orgId\": \"string\",\n \"data\": {}\n }\n }\n ]\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"webhooks:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List webhook endpoints", "request": { "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.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "developer", "webhooks" ], "raw": "{{baseUrl}}/api/developer/webhooks" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"orgId\": \"string\",\n \"count\": 0,\n \"items\": [\n {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"url\": \"string\",\n \"description\": \"string\",\n \"eventTypes\": [\n \"string\"\n ],\n \"secretPrefix\": \"string\",\n \"enabled\": true,\n \"disabledAt\": \"2026-01-31T12:00:00Z\",\n \"disabledReason\": \"manual\",\n \"consecutiveFailures\": 0,\n \"lastSuccessAt\": \"2026-01-31T12:00:00Z\",\n \"lastFailureAt\": \"2026-01-31T12:00:00Z\",\n \"createdByUserId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"eventTypes\": [\n {\n \"name\": \"string\",\n \"descriptionEs\": \"string\",\n \"descriptionEn\": \"string\"\n }\n ],\n \"maxEndpoints\": 0,\n \"endpoint\": {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"url\": \"string\",\n \"description\": \"string\",\n \"eventTypes\": [\n \"string\"\n ],\n \"secretPrefix\": \"string\",\n \"enabled\": true,\n \"disabledAt\": \"2026-01-31T12:00:00Z\",\n \"disabledReason\": \"manual\",\n \"consecutiveFailures\": 0,\n \"lastSuccessAt\": \"2026-01-31T12:00:00Z\",\n \"lastFailureAt\": \"2026-01-31T12:00:00Z\",\n \"createdByUserId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n },\n \"secretSource\": \"generated\",\n \"secret\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"webhooks:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Create a webhook endpoint", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"url\": \"\u003curl\u003e\"\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "developer", "webhooks" ], "raw": "{{baseUrl}}/api/developer/webhooks" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"orgId\": \"string\",\n \"count\": 0,\n \"items\": [\n {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"url\": \"string\",\n \"description\": \"string\",\n \"eventTypes\": [\n \"string\"\n ],\n \"secretPrefix\": \"string\",\n \"enabled\": true,\n \"disabledAt\": \"2026-01-31T12:00:00Z\",\n \"disabledReason\": \"manual\",\n \"consecutiveFailures\": 0,\n \"lastSuccessAt\": \"2026-01-31T12:00:00Z\",\n \"lastFailureAt\": \"2026-01-31T12:00:00Z\",\n \"createdByUserId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"eventTypes\": [\n {\n \"name\": \"string\",\n \"descriptionEs\": \"string\",\n \"descriptionEn\": \"string\"\n }\n ],\n \"maxEndpoints\": 0,\n \"endpoint\": {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"url\": \"string\",\n \"description\": \"string\",\n \"eventTypes\": [\n \"string\"\n ],\n \"secretPrefix\": \"string\",\n \"enabled\": true,\n \"disabledAt\": \"2026-01-31T12:00:00Z\",\n \"disabledReason\": \"manual\",\n \"consecutiveFailures\": 0,\n \"lastSuccessAt\": \"2026-01-31T12:00:00Z\",\n \"lastFailureAt\": \"2026-01-31T12:00:00Z\",\n \"createdByUserId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n },\n \"secretSource\": \"generated\",\n \"secret\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"webhooks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete a webhook endpoint", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"id\": \"\u003cid\u003e\"\n}" }, "description": "Delete a webhook endpoint\n\nAuthentication: developer API key with `webhooks:write` scope. Deletes the endpoint and its delivery history.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "developer", "webhooks", "delete" ], "raw": "{{baseUrl}}/api/developer/webhooks/delete" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"deleted\": true,\n \"id\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"webhooks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Redeliver an event", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"deliveryId\": \"\u003cdeliveryId\u003e\"\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "developer", "webhooks", "redeliver" ], "raw": "{{baseUrl}}/api/developer/webhooks/redeliver" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"queued\": true,\n \"deliveryId\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"webhooks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Rotate a webhook signing secret", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"id\": \"\u003cid\u003e\"\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "developer", "webhooks", "rotate-secret" ], "raw": "{{baseUrl}}/api/developer/webhooks/rotate-secret" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"endpoint\": {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"url\": \"string\",\n \"description\": \"string\",\n \"eventTypes\": [\n \"string\"\n ],\n \"secretPrefix\": \"string\",\n \"enabled\": true,\n \"disabledAt\": \"2026-01-31T12:00:00Z\",\n \"disabledReason\": \"manual\",\n \"consecutiveFailures\": 0,\n \"lastSuccessAt\": \"2026-01-31T12:00:00Z\",\n \"lastFailureAt\": \"2026-01-31T12:00:00Z\",\n \"createdByUserId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n },\n \"secretSource\": \"generated\",\n \"secret\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"webhooks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Send a test event", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"id\": \"\u003cid\u003e\"\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "developer", "webhooks", "test" ], "raw": "{{baseUrl}}/api/developer/webhooks/test" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"queued\": true,\n \"deliveryId\": \"string\",\n \"eventId\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"webhooks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Update a webhook endpoint", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"id\": \"\u003cid\u003e\"\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "developer", "webhooks", "update" ], "raw": "{{baseUrl}}/api/developer/webhooks/update" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"endpoint\": {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"url\": \"string\",\n \"description\": \"string\",\n \"eventTypes\": [\n \"string\"\n ],\n \"secretPrefix\": \"string\",\n \"enabled\": true,\n \"disabledAt\": \"2026-01-31T12:00:00Z\",\n \"disabledReason\": \"manual\",\n \"consecutiveFailures\": 0,\n \"lastSuccessAt\": \"2026-01-31T12:00:00Z\",\n \"lastFailureAt\": \"2026-01-31T12:00:00Z\",\n \"createdByUserId\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"webhooks:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Webhooks" }, { "item": [ { "name": "List agenda", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"from\": \"\",\n \"to\": \"\"\n }\n ]\n}" }, "description": "List agenda\n\nAuthentication: developer API key. Required scope: `agenda:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "agenda", "events", "list-agenda" ], "raw": "{{baseUrl}}/api/actions/agenda/events/list-agenda" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"items\": [\n {\n \"id\": \"string\",\n \"source\": \"string\",\n \"kind\": \"string\",\n \"title\": \"string\",\n \"startsAt\": \"2026-01-31T12:00:00Z\",\n \"endsAt\": \"2026-01-31T12:00:00Z\",\n \"location\": \"string\",\n \"videoUrl\": \"string\",\n \"notes\": \"string\",\n \"causaId\": \"string\",\n \"internalCauseId\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"expediente\": \"string\",\n \"invitees\": \"string\"\n }\n ],\n \"from\": \"2026-01-31T12:00:00Z\",\n \"to\": \"2026-01-31T12:00:00Z\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"agenda:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete agenda event", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete agenda event\n\nAuthentication: developer API key. Required scope: `agenda:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "agenda", "events", "delete-agenda-event" ], "raw": "{{baseUrl}}/api/actions/agenda/events/delete-agenda-event" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"agenda:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save agenda event", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"kind\": \"\",\n \"title\": \"\",\n \"startsAt\": \"\",\n \"endsAt\": \"\",\n \"location\": \"\",\n \"videoUrl\": \"\",\n \"notes\": \"\",\n \"causaId\": \"\",\n \"internalCauseId\": \"\",\n \"userIds\": [],\n \"clientIds\": [],\n \"emails\": [],\n \"notifyInvitees\": false\n }\n ]\n}" }, "description": "Save agenda event\n\nAuthentication: developer API key. Required scope: `agenda:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "agenda", "events", "save-agenda-event" ], "raw": "{{baseUrl}}/api/actions/agenda/events/save-agenda-event" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"agenda:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Agenda" }, { "item": [ { "name": "Get a public organization favicon", "request": { "auth": { "type": "noauth" }, "description": "Get a public organization favicon\n\nAuthentication: none.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "public", "organization-favicon" ], "raw": "{{baseUrl}}/api/public/organization-favicon" } }, "response": [ { "_postman_previewlanguage": "json", "body": "\u003cimage/* file\u003e", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success (file)", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get public ojv status snapshot", "request": { "auth": { "type": "noauth" }, "description": "Get public ojv status snapshot\n\nAuthentication: none. Public reference endpoint. Body: `{\"args\": [...]}`.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "public", "ojv-status", "get-public-ojv-status-snapshot" ], "raw": "{{baseUrl}}/api/actions/public/ojv-status/get-public-ojv-status-snapshot" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"current\": {\n \"id\": \"string\",\n \"checkedAt\": \"string\",\n \"pageStatus\": \"string\",\n \"responseTimeMs\": 0,\n \"httpStatusCode\": 0,\n \"status\": \"string\",\n \"errorCategory\": \"string\",\n \"textErrorDesc\": \"string\",\n \"textErrorTrace\": \"string\",\n \"clientTextError\": \"string\",\n \"dataValidated\": true,\n \"validationErrors\": [\n \"string\"\n ]\n },\n \"today\": [\n {\n \"id\": \"string\",\n \"checkedAt\": \"string\",\n \"pageStatus\": \"string\",\n \"responseTimeMs\": 0,\n \"httpStatusCode\": 0,\n \"status\": \"string\",\n \"errorCategory\": \"string\",\n \"textErrorDesc\": \"string\",\n \"textErrorTrace\": \"string\",\n \"clientTextError\": \"string\",\n \"dataValidated\": true,\n \"validationErrors\": [\n \"string\"\n ]\n }\n ],\n \"history\": [\n {\n \"date\": \"string\",\n \"totalChecks\": 0,\n \"upChecks\": 0,\n \"downChecks\": 0,\n \"uptimePercentage\": 0,\n \"avgResponseTime\": 0,\n \"minResponseTime\": 0,\n \"maxResponseTime\": 0\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get public organization branding", "request": { "auth": { "type": "noauth" }, "description": "Get public organization branding\n\nAuthentication: none.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "public", "organization-branding" ], "raw": "{{baseUrl}}/api/public/organization-branding" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"branding\": {\n \"displayName\": \"string\",\n \"logoUrl\": \"string\",\n \"primaryColor\": \"string\",\n \"accentColor\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get public system status snapshot", "request": { "auth": { "type": "noauth" }, "description": "Get public system status snapshot\n\nAuthentication: none. Public reference endpoint. Body: `{\"args\": [...]}`.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "public", "system-status", "get-public-system-status-snapshot" ], "raw": "{{baseUrl}}/api/actions/public/system-status/get-public-system-status-snapshot" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"checks\": [\n {\n \"key\": \"string\",\n \"subsystem\": \"string\",\n \"status\": \"string\",\n \"observedValue\": \"string\",\n \"threshold\": \"string\",\n \"message\": \"string\",\n \"source\": \"string\",\n \"observedAt\": \"2026-01-31T12:00:00Z\",\n \"days\": [\n {\n \"date\": \"2026-01-31\",\n \"total\": 0,\n \"healthy\": 0,\n \"degraded\": 0,\n \"failing\": 0\n }\n ]\n }\n ],\n \"historyDays\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get scheduled causes", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"page\": 0,\n \"per_page\": 0,\n \"sort\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"corteId\": \"\",\n \"rol\": \"\",\n \"caratulado\": \"\",\n \"tableName\": \"\",\n \"removed\": \"\",\n \"linkStatus\": \"\"\n }\n ]\n}" }, "description": "Get scheduled causes\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tablas", "queries", "get-scheduled-causes" ], "raw": "{{baseUrl}}/api/actions/tablas/queries/get-scheduled-causes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"scheduledCauses\": [\n {\n \"id\": \"string\",\n \"competence\": \"SUPREMA\",\n \"corteId\": 0,\n \"linkedCauses\": [\n {\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"c\": \"string\",\n \"causeId\": \"string\"\n }\n ],\n \"matchfound\": true,\n \"tableId\": \"string\",\n \"tableName\": \"string\",\n \"scheduledRoomId\": \"string\",\n \"scheduledRoomRef\": \"string\",\n \"scheduledRoomName\": \"string\",\n \"scheduledRoomDate\": \"2026-01-31T12:00:00Z\",\n \"position\": 0,\n \"caratulado\": \"string\",\n \"partialRol\": \"string\",\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"changedText\": \"string\",\n \"removed\": true,\n \"relatedOrgIds\": [\n \"string\"\n ],\n \"relatedTeamIds\": [\n \"string\"\n ]\n }\n ],\n \"pageCount\": 0,\n \"total\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reference:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get scheduled rooms", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"page\": 0,\n \"per_page\": 0,\n \"sort\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"corteId\": \"\",\n \"name\": \"\",\n \"relator\": \"\",\n \"tableName\": \"\"\n }\n ]\n}" }, "description": "Get scheduled rooms\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "tablas", "queries", "get-scheduled-rooms" ], "raw": "{{baseUrl}}/api/actions/tablas/queries/get-scheduled-rooms" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"scheduledRooms\": [\n {\n \"id\": \"string\",\n \"corteId\": 0,\n \"tableId\": \"string\",\n \"tableName\": \"string\",\n \"ref\": \"string\",\n \"name\": \"string\",\n \"date\": \"2026-01-31T12:00:00Z\",\n \"relator\": \"string\",\n \"members\": [\n {\n \"job\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"createdAt\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\",\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"removed\": true\n }\n ],\n \"pageCount\": 0,\n \"total\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reference:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Lookup boleta", "request": { "auth": { "type": "noauth" }, "description": "Lookup boleta\n\nAuthentication: none. Public reference endpoint. Body: `{\"args\": [...]}`.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "public", "boletas", "lookup-boleta" ], "raw": "{{baseUrl}}/api/actions/public/boletas/lookup-boleta" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"found\": true,\n \"tipo\": 0,\n \"tipoNombre\": \"string\",\n \"folio\": 0,\n \"fecha\": \"string\",\n \"total\": 0,\n \"aceptada\": true,\n \"emisor\": \"string\",\n \"rutEmisor\": \"string\",\n \"pdfUrl\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Resolve a public organization domain", "request": { "auth": { "type": "noauth" }, "description": "Resolve a public organization domain\n\nAuthentication: none.", "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "public", "resolve-domain" ], "raw": "{{baseUrl}}/api/public/resolve-domain" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"verified\": true,\n \"orgId\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Search ruts", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"rut\": \"\",\n \"nombre\": \"\",\n \"direccion\": \"\",\n \"email\": \"\",\n \"number\": \"\",\n \"content\": \"\",\n \"limit\": 0\n }\n ]\n}" }, "description": "Search ruts\n\nAuthentication: developer API key. Required scope: `reference:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "rut-search", "search-ruts" ], "raw": "{{baseUrl}}/api/actions/rut-search/search-ruts" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"count\": 0,\n \"limit\": 0,\n \"items\": [\n {\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"sexo\": \"string\",\n \"domicilioElectoral\": \"string\",\n \"circunscripcion\": \"string\",\n \"mesa\": \"string\",\n \"emails\": [\n \"string\"\n ],\n \"phones\": [\n \"string\"\n ],\n \"source\": \"string\",\n \"cacheState\": \"string\",\n \"lastSyncedAt\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"reference:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Reference data" }, { "item": [ { "name": "Fetch lookup document", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"orgId\": \"\",\n \"lookupId\": \"\",\n \"documentRef\": \"\",\n \"_lookupCaller\": {\n \"source\": \"\",\n \"apiKeyId\": \"\"\n }\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "causa-lookup", "mutations", "fetch-lookup-document" ], "raw": "{{baseUrl}}/api/actions/causa-lookup/mutations/fetch-lookup-document" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"url\": \"string\",\n \"expiresAt\": \"2026-01-31T12:00:00Z\",\n \"fileName\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:lookup\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get calendar sync status", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "preferences", "calendar", "get-calendar-sync-status" ], "raw": "{{baseUrl}}/api/actions/preferences/calendar/get-calendar-sync-status" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"providers\": [\n {\n \"provider\": \"string\",\n \"configured\": true,\n \"status\": \"string\",\n \"lastSyncAt\": \"2026-01-31T12:00:00Z\",\n \"lastError\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get causa custom attributes", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "custom-attributes", "settings", "get-cause-custom-attributes" ], "raw": "{{baseUrl}}/api/actions/custom-attributes/settings/get-cause-custom-attributes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"attributes\": [\n {\n \"id\": \"string\",\n \"entity\": \"string\",\n \"key\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"options\": [\n \"string\"\n ],\n \"required\": true,\n \"placeholder\": \"string\",\n \"position\": 0\n }\n ],\n \"values\": {\n \"\u003ckey\u003e\": \"string\"\n },\n \"canEdit\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"settings:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get client billing workspace data", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {}\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "billing", "queries", "get-client-billing-workspace-data" ], "raw": "{{baseUrl}}/api/actions/billing/queries/get-client-billing-workspace-data" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"errorEn\": \"string\",\n \"data\": {\n \"organizationIds\": [\n \"string\"\n ],\n \"resolvedOrganizationId\": \"string\",\n \"organizations\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"subscription\": \"string\",\n \"commercialPlan\": \"string\",\n \"connectedCauseCap\": 0,\n \"extraCausaClp\": 0,\n \"apiIncludedRequestsPerCause\": 0,\n \"activeConnectedCauses\": 0,\n \"billableConnectedCauses\": 0,\n \"includedApiRequests\": 0,\n \"apiBillableUnitsCurrentMonth\": 0,\n \"apiOverageUnitsCurrentMonth\": 0,\n \"billingWarning\": \"string\",\n \"hasFinancialProfile\": true,\n \"provider\": \"string\",\n \"openInvoices\": 0,\n \"overdueInvoices\": 0,\n \"nextDueDate\": \"string\",\n \"financialProfile\": {\n \"companyName\": \"string\",\n \"rut\": \"string\",\n \"country\": \"string\",\n \"comuna\": \"string\",\n \"address\": \"string\",\n \"giro\": \"string\",\n \"dteEmail\": \"string\",\n \"cardCount\": 0,\n \"provider\": \"string\"\n },\n \"activeCoupons\": [\n {\n \"kind\": \"string\",\n \"description\": \"string\",\n \"descriptionEn\": \"string\",\n \"remaining\": \"string\",\n \"remainingEn\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\",\n \"active\": true,\n \"valid\": true,\n \"quantityLeft\": 0,\n \"validFrom\": \"string\",\n \"validUntil\": \"string\",\n \"amount\": \"string\",\n \"discount\": 0,\n \"historyCreatedAt\": \"string\",\n \"eliminatedAt\": \"string\"\n }\n ],\n \"couponHistory\": [\n {\n \"kind\": \"string\",\n \"description\": \"string\",\n \"descriptionEn\": \"string\",\n \"remaining\": \"string\",\n \"remainingEn\": \"string\",\n \"id\": \"string\",\n \"code\": \"string\",\n \"active\": true,\n \"valid\": true,\n \"quantityLeft\": 0,\n \"validFrom\": \"string\",\n \"validUntil\": \"string\",\n \"amount\": \"string\",\n \"discount\": 0,\n \"historyCreatedAt\": \"string\",\n \"eliminatedAt\": \"string\"\n }\n ],\n \"serviceUsage\": null,\n \"watchedRuts\": 0,\n \"rutMonitorFreeRuts\": 0,\n \"rutMonitorExtraRuts\": 0,\n \"rutMonitorPriceInclusive\": 0,\n \"rutMonitorEstimatedInclusive\": 0\n }\n ],\n \"invoices\": [\n {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"orgName\": \"string\",\n \"invoiceNumber\": 0,\n \"status\": \"string\",\n \"subscription\": \"string\",\n \"commercialPlan\": \"string\",\n \"total\": 0,\n \"dueDate\": \"string\",\n \"paidAt\": \"string\",\n \"paymentStatus\": \"string\",\n \"paymentStatusDetail\": \"string\",\n \"invoicePdfUrl\": \"string\",\n \"tryNumber\": 0,\n \"billableConnectedCauseCount\": 0,\n \"actualConnectedCauseCount\": 0,\n \"connectedCauseCap\": 0,\n \"includedApiRequests\": 0,\n \"apiBillableUnits\": 0,\n \"apiOverageUnits\": 0,\n \"apiOverageSubtotal\": 0,\n \"watchedRuts\": 0,\n \"rutMonitorFreeRuts\": 0,\n \"rutMonitorBillableRuts\": 0,\n \"rutMonitorSubtotal\": 0,\n \"billingWarning\": \"string\",\n \"lines\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"quantity\": \"string\",\n \"unitAmount\": 0,\n \"subtotal\": 0\n }\n ],\n \"mpPaymentId\": \"string\"\n }\n ],\n \"upcomingInvoices\": [\n {\n \"id\": \"string\",\n \"orgId\": \"string\",\n \"orgName\": \"string\",\n \"invoiceNumber\": 0,\n \"status\": \"string\",\n \"subscription\": \"string\",\n \"commercialPlan\": \"string\",\n \"total\": 0,\n \"dueDate\": \"string\",\n \"paidAt\": \"string\",\n \"paymentStatus\": \"string\",\n \"paymentStatusDetail\": \"string\",\n \"invoicePdfUrl\": \"string\",\n \"tryNumber\": 0,\n \"billableConnectedCauseCount\": 0,\n \"actualConnectedCauseCount\": 0,\n \"connectedCauseCap\": 0,\n \"includedApiRequests\": 0,\n \"apiBillableUnits\": 0,\n \"apiOverageUnits\": 0,\n \"apiOverageSubtotal\": 0,\n \"watchedRuts\": 0,\n \"rutMonitorFreeRuts\": 0,\n \"rutMonitorBillableRuts\": 0,\n \"rutMonitorSubtotal\": 0,\n \"billingWarning\": \"string\",\n \"lines\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"quantity\": \"string\",\n \"unitAmount\": 0,\n \"subtotal\": 0\n }\n ],\n \"mpPaymentId\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get client dashboard data", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"defaultOrganization\": \"\",\n \"defaultTeam\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "dashboard", "queries", "get-client-dashboard-data" ], "raw": "{{baseUrl}}/api/actions/dashboard/queries/get-client-dashboard-data" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"scope\": {\n \"mode\": \"string\",\n \"defaultOrganization\": \"string\",\n \"defaultTeam\": \"string\",\n \"memberships\": 0,\n \"resolvedOrgIds\": [\n \"string\"\n ],\n \"resolvedOrgName\": \"string\",\n \"resolvedTeamId\": \"string\",\n \"resolvedTeamName\": \"string\",\n \"organizations\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"active\": true,\n \"role\": \"string\",\n \"isPersonal\": true,\n \"createdByCurrentUser\": true,\n \"hasBillingCard\": true,\n \"canManageDeveloperKeys\": true,\n \"canInviteUsers\": true,\n \"canInviteByRole\": true,\n \"canManageTeams\": true,\n \"freeTrackedCauseLimit\": 0,\n \"freeTrackedCauseCount\": 0,\n \"canCreateAnotherOrganization\": true,\n \"createBlockedReason\": \"string\",\n \"liquidacionesPublicEnabled\": true,\n \"liquidacionesLiquidadorEnabled\": true,\n \"exhortoAutoTrackingEnabled\": true,\n \"exhortoAutoUntrackOnConclusion\": true,\n \"aiAccessEnabled\": true,\n \"roleFeatureVisibility\": {}\n }\n ],\n \"teams\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"orgId\": \"string\"\n }\n ],\n \"resolvedOrganizationId\": \"string\"\n },\n \"orgKpis\": {\n \"organizations\": 0,\n \"activeOrganizations\": 0,\n \"teams\": 0,\n \"clients\": 0\n },\n \"billingKpis\": {\n \"totalInvoices\": 0,\n \"openInvoices\": 0,\n \"dueSoonInvoices\": 0,\n \"overdueInvoices\": 0,\n \"lateInvoices\": 0,\n \"paidInvoices30d\": 0,\n \"paidAmount30d\": 0,\n \"financialProfiles\": 0,\n \"organizationsWithoutFinancialProfile\": 0,\n \"subscriptionMix\": {\n \"unitary\": 0,\n \"bundle\": 0,\n \"fix\": 0\n },\n \"invoiceStatusMix\": {\n \"pending\": 0,\n \"inProgress\": 0,\n \"subscriptionPending\": 0,\n \"tc1\": 0,\n \"tc2\": 0,\n \"paid\": 0,\n \"late\": 0,\n \"error\": 0\n }\n },\n \"emptyState\": {\n \"hasAssignments\": true,\n \"message\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get current user role", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "user", "get-current-user-role" ], "raw": "{{baseUrl}}/api/actions/user/get-current-user-role" } }, "response": [ { "_postman_previewlanguage": "json", "body": "\"string\"", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get dashboard scope options", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "dashboard", "queries", "get-dashboard-scope-options" ], "raw": "{{baseUrl}}/api/actions/dashboard/queries/get-dashboard-scope-options" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"defaultOrganization\": \"string\",\n \"defaultTeam\": \"string\",\n \"mode\": \"string\",\n \"organizations\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"active\": true,\n \"role\": \"string\",\n \"isPersonal\": true,\n \"createdByCurrentUser\": true,\n \"hasBillingCard\": true,\n \"canManageDeveloperKeys\": true,\n \"canInviteUsers\": true,\n \"canInviteByRole\": true,\n \"canManageTeams\": true,\n \"freeTrackedCauseLimit\": 0,\n \"freeTrackedCauseCount\": 0,\n \"canCreateAnotherOrganization\": true,\n \"createBlockedReason\": \"string\",\n \"liquidacionesPublicEnabled\": true,\n \"liquidacionesLiquidadorEnabled\": true,\n \"exhortoAutoTrackingEnabled\": true,\n \"exhortoAutoUntrackOnConclusion\": true,\n \"aiAccessEnabled\": true,\n \"roleFeatureVisibility\": {}\n }\n ],\n \"teams\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"orgId\": \"string\"\n }\n ],\n \"allTeams\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"orgId\": \"string\"\n }\n ],\n \"resolvedOrganizationId\": \"string\",\n \"resolvedOrganizationName\": \"string\",\n \"resolvedTeamId\": \"string\",\n \"hasDeveloperKeyAccess\": true,\n \"forcedByDomain\": true,\n \"creation\": {\n \"createdOrganizationCount\": 0,\n \"hasPersonalOrganization\": true,\n \"billingUnlocked\": true,\n \"canCreateAnotherOrganization\": true,\n \"canCreatePersonalOrganization\": true,\n \"createBlockedReason\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get deudor sii", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"rut\": \"\"\n }\n ]\n}" }, "description": "Get deudor sii\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "deudores", "queries", "get-deudor-sii" ], "raw": "{{baseUrl}}/api/actions/deudores/queries/get-deudor-sii" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rut\": \"string\",\n \"canWrite\": true,\n \"hasCredential\": true,\n \"nombre\": \"string\",\n \"publishedName\": \"string\",\n \"note\": \"string\",\n \"statusCheck\": \"string\",\n \"lastCheck\": \"2026-01-31T12:00:00Z\",\n \"updatedAt\": \"2026-01-31T12:00:00Z\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get deudores summary", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"search\": \"\",\n \"estado\": \"\",\n \"page\": 0,\n \"perPage\": 0\n }\n ]\n}" }, "description": "Get deudores summary\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "deudores", "queries", "get-deudores-summary" ], "raw": "{{baseUrl}}/api/actions/deudores/queries/get-deudores-summary" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"deudores\": [\n {\n \"key\": \"string\",\n \"rut\": \"string\",\n \"rutRaw\": \"string\",\n \"nombre\": \"string\",\n \"estado\": \"string\",\n \"active\": true,\n \"procedimientos\": 0,\n \"assignees\": [\n \"string\"\n ],\n \"creditos\": 0,\n \"creditosPorVerificar\": 0,\n \"bienes\": 0,\n \"bienesPorVerificar\": 0,\n \"bienesConAvaluoFiscal\": 0,\n \"hasSii\": true,\n \"siiStatus\": \"OK\",\n \"siiLastCheck\": \"string\",\n \"siiUpdatedAt\": \"string\"\n }\n ],\n \"total\": 0,\n \"page\": 0,\n \"perPage\": 0,\n \"estado\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get home overview", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Get home overview\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "dashboard", "home", "get-home-overview" ], "raw": "{{baseUrl}}/api/actions/dashboard/home/get-home-overview" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"kpis\": {\n \"causasTotal\": 0,\n \"causasInProgress\": 0,\n \"causasStalled\": 0,\n \"causasClosed\": 0,\n \"tasksOverdue\": 0,\n \"tasksToReview\": 0,\n \"hearingsNext7Days\": 0\n },\n \"attention\": {\n \"overdueTasks\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"status\": \"string\",\n \"dueDate\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"causaProblems\": [\n {\n \"id\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"kind\": \"credential\",\n \"detail\": \"string\"\n }\n ],\n \"reviewTasks\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"status\": \"string\",\n \"dueDate\": \"2026-01-31T12:00:00Z\"\n }\n ]\n },\n \"recent\": [\n {\n \"entityType\": \"CAUSA\",\n \"entityId\": \"string\",\n \"viewedAt\": \"2026-01-31T12:00:00Z\",\n \"rol\": \"string\",\n \"caratulado\": \"string\"\n }\n ]\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get onboarding", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Get onboarding\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "onboarding", "wizard", "get-onboarding" ], "raw": "{{baseUrl}}/api/actions/onboarding/wizard/get-onboarding" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"pending\": true,\n \"step\": \"string\",\n \"completed\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get plan options", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": []\n}" }, "description": "Get plan options\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "billing", "queries", "get-plan-options" ], "raw": "{{baseUrl}}/api/actions/billing/queries/get-plan-options" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"currentPlan\": \"string\",\n \"activeConnectedCauses\": 0,\n \"selfService\": true,\n \"negotiated\": true,\n \"negotiatedTerms\": [\n {\n \"kind\": \"variable\",\n \"amount\": 0,\n \"count\": 0\n }\n ],\n \"options\": [\n {\n \"plan\": \"string\",\n \"monthlyNet\": 0,\n \"monthlyInclusive\": 0,\n \"causeCap\": 0,\n \"extraCausaClp\": 0,\n \"extraCauses\": 0,\n \"estimatedInclusive\": 0,\n \"current\": true,\n \"allowed\": true,\n \"reason\": \"string\",\n \"upgrade\": true,\n \"appliesImmediately\": true,\n \"starterBands\": [\n {\n \"limitInclusive\": 0,\n \"priceInclusive\": 0\n }\n ]\n }\n ],\n \"pendingChange\": {\n \"plan\": \"string\",\n \"requestedAt\": \"string\",\n \"appliesAt\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Get watch summary", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"upcomingMax\": 0\n }\n ]\n}" }, "description": "Get watch summary\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "watch", "queries", "get-watch-summary" ], "raw": "{{baseUrl}}/api/actions/watch/queries/get-watch-summary" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"briefing\": \"string\",\n \"date\": \"string\",\n \"generatedAt\": \"2026-01-31T12:00:00Z\",\n \"today\": [\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"label\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"location\": \"string\",\n \"at\": \"2026-01-31T12:00:00Z\",\n \"allDay\": true,\n \"taskId\": \"string\",\n \"causaId\": \"string\",\n \"displayTitle\": \"string\",\n \"whenLabel\": \"string\"\n }\n ],\n \"upcoming\": [\n {\n \"id\": \"string\",\n \"kind\": \"string\",\n \"label\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"location\": \"string\",\n \"at\": \"2026-01-31T12:00:00Z\",\n \"allDay\": true,\n \"taskId\": \"string\",\n \"causaId\": \"string\",\n \"displayTitle\": \"string\",\n \"whenLabel\": \"string\"\n }\n ],\n \"overdueTasks\": 0\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Global search", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"query\": \"\",\n \"limit\": 0,\n \"group\": \"\"\n }\n ]\n}" }, "description": "Global search\n\nAuthentication: developer API key. Required scope: `product:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "search", "queries", "global-search" ], "raw": "{{baseUrl}}/api/actions/search/queries/global-search" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"query\": \"string\",\n \"tooShort\": true,\n \"groups\": [\n {\n \"key\": \"string\",\n \"items\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"subtitle\": \"string\",\n \"params\": {\n \"\u003ckey\u003e\": \"string\"\n }\n }\n ],\n \"more\": true\n }\n ],\n \"liquidacionesEnabled\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List custom attributes", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"entity\": \"\"\n }\n ]\n}" }, "description": "List custom attributes\n\nAuthentication: developer API key. Required scope: `settings:read`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "custom-attributes", "settings", "list-custom-attributes" ], "raw": "{{baseUrl}}/api/actions/custom-attributes/settings/list-custom-attributes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"attributes\": [\n {\n \"id\": \"string\",\n \"entity\": \"string\",\n \"key\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"options\": [\n \"string\"\n ],\n \"required\": true,\n \"placeholder\": \"string\",\n \"position\": 0\n }\n ],\n \"canEdit\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"settings:read\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "List lookups", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"orgId\": \"\",\n \"lookupId\": \"\"\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "causa-lookup", "queries", "list-lookups" ], "raw": "{{baseUrl}}/api/actions/causa-lookup/queries/list-lookups" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"items\": [\n {\n \"lookupId\": \"string\",\n \"competence\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"tribunal\": \"string\",\n \"source\": \"string\",\n \"fetchedAt\": \"string\"\n }\n ],\n \"lookupId\": \"string\",\n \"fetchedAt\": \"2026-01-31T12:00:00Z\",\n \"cached\": true,\n \"causa\": \"string\",\n \"documents\": \"string\",\n \"follow\": {\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"libro\": \"string\",\n \"val\": \"string\",\n \"year\": \"string\"\n },\n \"prices\": {\n \"consulta\": 0,\n \"documento\": 0\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:lookup\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Lookup causa", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"orgId\": \"\",\n \"teamIds\": [],\n \"competence\": \"\",\n \"libro\": \"\",\n \"val\": \"\",\n \"year\": \"\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"clientIds\": [],\n \"private\": false,\n \"rol\": \"\",\n \"_lookupCaller\": {\n \"source\": \"\",\n \"apiKeyId\": \"\"\n }\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "causa-lookup", "queries", "lookup-causa" ], "raw": "{{baseUrl}}/api/actions/causa-lookup/queries/lookup-causa" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"queueable\": true,\n \"data\": {\n \"lookupId\": \"string\",\n \"fetchedAt\": \"2026-01-31T12:00:00Z\",\n \"cached\": true,\n \"causa\": {\n \"basicInfo\": {\n \"competence\": \"string\",\n \"rol\": \"string\",\n \"caratulado\": \"string\",\n \"textoDemandas\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\"\n }\n ],\n \"estadosProcesal\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"fechaIng\": \"2026-01-31T12:00:00Z\",\n \"certEnvioId\": \"string\",\n \"ebookId\": \"string\",\n \"etapas\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"anexos\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\"\n }\n ],\n \"estadosAdmin\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"tipoProcedimiento\": \"string\",\n \"tomos\": [\n {\n \"tomo\": \"string\",\n \"fojaInicio\": \"string\",\n \"fojaFin\": \"string\",\n \"principal\": true\n }\n ],\n \"docsCausa\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\"\n }\n ],\n \"obs\": {\n \"raw\": \"string\",\n \"relatorAsignado\": \"string\"\n },\n \"relator\": \"string\",\n \"incompetencias\": [\n {\n \"rol\": \"string\",\n \"tribunalId\": 0\n }\n ],\n \"ubicaciones\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"ruc\": \"string\",\n \"tribunalOrigenId\": 0,\n \"juezAsignado\": \"string\",\n \"tituloEjecutivo\": \"string\",\n \"estadosDeuda\": [\n {\n \"prestacion\": \"string\",\n \"fechaPrestacion\": \"2026-01-31T12:00:00Z\",\n \"fechaActualizar\": \"2026-01-31T12:00:00Z\",\n \"saldoDeuda\": 0,\n \"fechaLiq\": \"2026-01-31T12:00:00Z\",\n \"porcentajeReajuste\": 0,\n \"porcentajeInteres\": 0\n }\n ],\n \"formaDeInicio\": \"string\",\n \"materias\": [\n {\n \"codigo\": \"string\",\n \"glosa\": \"string\",\n \"estado\": \"string\",\n \"fechaTermino\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"docErrors\": [\n \"string\"\n ]\n },\n \"litigantes\": [\n {\n \"participante\": \"string\",\n \"rut\": \"string\",\n \"persona\": \"string\",\n \"nombre\": \"string\",\n \"abogadoDefensor\": true,\n \"estado\": true\n }\n ],\n \"exhortos\": [\n {\n \"rolOrigen\": \"string\",\n \"tipoExhorto\": \"string\",\n \"documentosExhortos\": [\n {\n \"index\": 0,\n \"doc\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"pieza\": \"string\"\n }\n ],\n \"fechaOrdenaExhorto\": \"2026-01-31T12:00:00Z\",\n \"fechaIngresaExhorto\": \"2026-01-31T12:00:00Z\",\n \"rolDestino\": \"string\",\n \"tribunalDestino\": 0,\n \"tribunalDestinoName\": \"string\",\n \"estadoExhorto\": \"string\",\n \"tribunalOrigen\": \"string\",\n \"docErrors\": [\n \"string\"\n ]\n }\n ],\n \"remisiones\": [\n {\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"competence\": \"string\",\n \"rol\": \"string\",\n \"texto\": \"string\",\n \"tipo\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"notificacionesReceptor\": [\n {\n \"index\": 0,\n \"cuaderno\": \"string\",\n \"datosDelRetiro\": \"string\",\n \"fechaRetiro\": \"2026-01-31T12:00:00Z\",\n \"estado\": \"string\"\n }\n ],\n \"plazos\": [\n {\n \"tipoPlazo\": \"string\",\n \"ambitoAfectado\": \"string\",\n \"fechaInicio\": \"2026-01-31T12:00:00Z\",\n \"fechaTermino\": \"2026-01-31T12:00:00Z\",\n \"duracion\": \"string\",\n \"estado\": \"string\",\n \"tramite\": \"string\",\n \"fechaSuspencion\": \"2026-01-31T12:00:00Z\",\n \"fechaReactivacion\": \"2026-01-31T12:00:00Z\"\n }\n ],\n \"liquidaciones\": [\n {\n \"fechaTramite\": \"2026-01-31T12:00:00Z\",\n \"cuadernoLiq\": \"string\",\n \"estado\": \"string\",\n \"monto\": 0,\n \"nombre\": \"string\",\n \"rut\": \"string\"\n }\n ],\n \"cuadernosData\": [\n {\n \"historias\": [\n {\n \"order\": 0,\n \"folio\": \"string\",\n \"nulo\": true,\n \"reposicion\": true,\n \"mismoFolio\": 0,\n \"doc\": \"string\",\n \"especial\": true,\n \"sala\": \"string\",\n \"certEnvioId\": \"string\",\n \"anexoType\": \"string\",\n \"anexos\": [\n {\n \"index\": 0,\n \"doc\": null,\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\"\n }\n ],\n \"etapa\": \"string\",\n \"estado\": \"string\",\n \"tramite\": \"string\",\n \"descTramite\": \"string\",\n \"fechaTramite\": \"2026-01-31T12:00:00Z\",\n \"segundaFechaTramite\": \"2026-01-31T12:00:00Z\",\n \"fechaRecepcion\": \"2026-01-31T12:00:00Z\",\n \"foja\": \"string\",\n \"georref\": {\n \"latitud\": 0,\n \"longitud\": 0,\n \"lat\": 0,\n \"lng\": 0,\n \"corrector\": 0\n },\n \"docsDescTramite\": [\n {\n \"doc\": null,\n \"fecha\": \"string\",\n \"referencia\": \"string\"\n }\n ],\n \"conAudios\": true,\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"monto\": 0,\n \"cuadernoLiq\": \"string\",\n \"anexosToken\": \"string\",\n \"docErrors\": [\n \"string\"\n ]\n }\n ],\n \"notificaciones\": [\n {\n \"index\": 0,\n \"rol\": \"string\",\n \"estadoNotif\": \"string\",\n \"tipoNotif\": \"string\",\n \"fechaTramite\": \"2026-01-31T12:00:00Z\",\n \"fechaAudiencia\": \"2026-01-31T12:00:00Z\",\n \"tipoPart\": \"string\",\n \"nombre\": \"string\",\n \"tramite\": \"string\",\n \"obsFallida\": \"string\",\n \"ruc\": \"string\",\n \"enteNotificador\": \"string\",\n \"notificationDetail\": [\n {\n \"idx\": 0,\n \"codigo\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"tipo\": \"string\",\n \"observación\": \"string\"\n }\n ],\n \"identityKey\": \"string\"\n }\n ],\n \"escritosPorResolver\": [\n {\n \"doc\": \"string\",\n \"anexos\": [\n {\n \"index\": 0,\n \"doc\": null,\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"tramite\": \"string\",\n \"codigo\": \"string\",\n \"cantidad\": 0,\n \"tipoDoc\": \"string\",\n \"rut\": \"string\",\n \"nombre\": \"string\",\n \"docFisico\": \"string\",\n \"doctoFisico\": \"string\",\n \"estadoFirma\": \"string\",\n \"tipoLit\": \"string\"\n }\n ],\n \"fechaIngreso\": \"2026-01-31T12:00:00Z\",\n \"tipo\": \"string\",\n \"solicitante\": \"string\",\n \"referencia\": \"string\",\n \"indexPorFecha\": 0,\n \"docErrors\": [\n \"string\"\n ]\n }\n ],\n \"cuaderno\": {\n \"index\": 0,\n \"order\": 0,\n \"name\": \"string\",\n \"estadosProcesal\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"etapas\": [\n {\n \"changedAt\": \"2026-01-31T12:00:00Z\",\n \"value\": \"string\",\n \"counter\": 0\n }\n ],\n \"tipoProcedimiento\": \"string\"\n },\n \"audios\": [\n {\n \"numero\": 0,\n \"audio\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"referencia\": \"string\",\n \"docErrors\": [\n \"string\"\n ]\n }\n ],\n \"diligencias\": [\n {\n \"index\": 0,\n \"docIda\": \"string\",\n \"docVta\": \"string\",\n \"estado\": \"string\",\n \"rit\": \"string\",\n \"ruc\": \"string\",\n \"tipoDiligencia\": \"string\",\n \"referencia\": \"string\",\n \"destinatario\": \"string\",\n \"responsable\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"docErrors\": [\n \"string\"\n ],\n \"identityKey\": \"string\"\n }\n ],\n \"relaciones\": [\n {\n \"index\": 0,\n \"nombre\": \"string\",\n \"delito\": \"string\",\n \"estado\": \"string\",\n \"fechaCambioEstado\": \"2026-01-31T12:00:00Z\",\n \"identityKey\": \"string\"\n }\n ]\n }\n ]\n },\n \"documents\": [\n {\n \"documentRef\": \"string\",\n \"kind\": \"string\",\n \"cuaderno\": \"string\",\n \"folio\": \"string\",\n \"fecha\": \"2026-01-31T12:00:00Z\",\n \"descripcion\": \"string\"\n }\n ],\n \"follow\": {\n \"competence\": \"string\",\n \"corteId\": 0,\n \"tribunalId\": 0,\n \"libro\": \"string\",\n \"val\": \"string\",\n \"year\": \"string\"\n }\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"causas:lookup\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Delete custom attribute", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\"\n }\n ]\n}" }, "description": "Delete custom attribute\n\nAuthentication: developer API key. Required scope: `settings:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "custom-attributes", "settings", "delete-custom-attribute" ], "raw": "{{baseUrl}}/api/actions/custom-attributes/settings/delete-custom-attribute" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"settings:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Move custom attribute", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"direction\": \"\"\n }\n ]\n}" }, "description": "Move custom attribute\n\nAuthentication: developer API key. Required scope: `settings:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "custom-attributes", "settings", "move-custom-attribute" ], "raw": "{{baseUrl}}/api/actions/custom-attributes/settings/move-custom-attribute" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"settings:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Record recent view", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"entityType\": \"\",\n \"entityId\": \"\"\n }\n ]\n}" }, "description": "Record recent view\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "dashboard", "home", "record-recent-view" ], "raw": "{{baseUrl}}/api/actions/dashboard/home/record-recent-view" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"recorded\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save custom attribute", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"id\": \"\",\n \"entity\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"options\": [],\n \"required\": false,\n \"placeholder\": \"\"\n }\n ]\n}" }, "description": "Save custom attribute\n\nAuthentication: developer API key. Required scope: `settings:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "custom-attributes", "settings", "save-custom-attribute" ], "raw": "{{baseUrl}}/api/actions/custom-attributes/settings/save-custom-attribute" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"settings:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save deudor sii", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"rut\": \"\",\n \"nombre\": \"\",\n \"password\": \"\",\n \"note\": \"\"\n }\n ]\n}" }, "description": "Save deudor sii\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "deudores", "mutations", "save-deudor-sii" ], "raw": "{{baseUrl}}/api/actions/deudores/mutations/save-deudor-sii" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"rut\": \"string\",\n \"hasCredential\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Save onboarding", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"step\": \"\",\n \"skippedSync\": false,\n \"finish\": false\n }\n ]\n}" }, "description": "Save onboarding\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "onboarding", "wizard", "save-onboarding" ], "raw": "{{baseUrl}}/api/actions/onboarding/wizard/save-onboarding" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"ok\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set causa custom attributes", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"causaId\": \"\",\n \"values\": {}\n }\n ]\n}" }, "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.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "custom-attributes", "settings", "set-cause-custom-attributes" ], "raw": "{{baseUrl}}/api/actions/custom-attributes/settings/set-cause-custom-attributes" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"success\": true\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"settings:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Set dashboard scope", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"defaultOrganization\": \"\",\n \"defaultTeam\": \"\"\n }\n ]\n}" }, "description": "Set dashboard scope\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "dashboard", "preferences", "set-dashboard-scope" ], "raw": "{{baseUrl}}/api/actions/dashboard/preferences/set-dashboard-scope" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"ok\": true,\n \"defaultOrganization\": \"string\",\n \"defaultTeam\": \"string\",\n \"mode\": \"string\",\n \"resolvedOrgIds\": [\n \"string\"\n ],\n \"resolvedTeamId\": \"string\"\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] }, { "name": "Start onboarding sync", "request": { "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"args\": [\n {\n \"clientId\": \"\",\n \"materias\": []\n }\n ]\n}" }, "description": "Start onboarding sync\n\nAuthentication: developer API key. Required scope: `product:write`. Action route. Body: `{\"args\": [...]}`; responses are the action's JSON payload.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "api", "actions", "onboarding", "wizard", "start-onboarding-sync" ], "raw": "{{baseUrl}}/api/actions/onboarding/wizard/start-onboarding-sync" } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"sourceId\": \"string\"\n }\n}", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Success", "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Indica el procedimiento.\",\n \"errorCode\": \"INVALID_REQUEST\",\n \"message\": \"The request is invalid: a required field is missing or a value is not accepted.\",\n \"messageEs\": \"Indica el procedimiento.\",\n \"status\": 400\n}", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Invalid request", "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Unauthorized\",\n \"errorCode\": \"API_KEY_INVALID\",\n \"message\": \"This API key does not exist or was mistyped. Copy it again from where you saved it when it was created, or create a new one.\",\n \"messageEs\": \"Esta llave API no existe o está mal escrita. Cópiala de nuevo desde donde la guardaste al crearla, o crea una nueva.\",\n \"status\": 401\n}", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Authentication required", "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"insufficient_scope\",\n \"errorCode\": \"INSUFFICIENT_SCOPE\",\n \"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).\",\n \"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).\",\n \"requiredScope\": \"product:write\",\n \"status\": 403\n}", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Missing scope", "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"payment_method_required\",\n \"errorCode\": \"PAYMENT_METHOD_REQUIRED\",\n \"message\": \"The organization used up its free API quota: add a payment method under Billing to keep calling the API.\",\n \"messageEs\": \"La organización agotó su cuota gratuita de API: agrega un medio de pago en Facturación para seguir usando la API.\",\n \"status\": 402\n}", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Payment required", "status": "Payment Required" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"Causa no encontrada en esta organización.\",\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist in the API key's organization.\",\n \"messageEs\": \"Causa no encontrada en esta organización.\",\n \"status\": 404\n}", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Not found", "status": "Not Found" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"No se pudo completar la gestión.\",\n \"errorCode\": \"UNPROCESSABLE\",\n \"message\": \"The request was understood but could not be completed.\",\n \"messageEs\": \"No se pudo completar la gestión.\",\n \"status\": 422\n}", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Could not complete", "status": "Unprocessable Entity" }, { "_postman_previewlanguage": "json", "body": "{\n \"docs\": \"https://www.nexulex.com/docs/api#errors\",\n \"error\": \"rate_limited\",\n \"errorCode\": \"RATE_LIMITED\",\n \"message\": \"This API key is limited to 120 requests per minute: wait 12 s (Retry-After) and try again.\",\n \"messageEs\": \"Esta llave API admite 120 solicitudes por minuto: espera 12 s (Retry-After) y reintenta.\",\n \"retryAfter\": 12,\n \"status\": 429\n}", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "name": "Rate limited", "status": "Too Many Requests" } ] } ], "name": "Other product features" } ], "variable": [ { "key": "baseUrl", "type": "string", "value": "https://api.nexulex.com" }, { "key": "apiKey", "type": "string", "value": "" } ] }