Obtener lista de clasificaciones de clientes

Lista todas las clasificaciones de clientes registradas en el sistema. Permite organizar y gestionar las categorías de clientes de forma eficiente.

---

Entorno

URL Base: https://api.guarani.app

Endpoint

GET /clientes-clasificaciones?page=1&limit=100

Ejemplo de solicitud

curl -X GET "https://api.guarani.app/clientes-clasificaciones?page=1&limit=100" \
-H "x-api-key: Bearer <access_token>" \
-H "Accept: application/json" | jq

Nota: Asegúrate de reemplazar <access_token> con un token JWT válido proporcionado por el equipo Guarani. Importante:
Es imprescindible incluir un token de acceso válido en el encabezado x-api-key para autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.

---

Parámetros de ruta

Parámetro	Tipo	Requerido	Descripción
page	integer	No	Número de página. Por defecto: 1.
limit	integer	No	Resultados por página. Por defecto: 100

Encabezados de la Solicitud

Encabezado	Valor	Descripción
x-api-key	Bearer <access_token>	Token de autenticación necesario para acceder al recurso.
Accept	application/json	Indica que la respuesta debe devolverse en formato JSON.

Ejemplo de respuesta

{
  "success": true,
  "codigo": "200",
  "message": "Operación realizada correctamente.",
  "data": [
    {
      "id": "c5a0b11f-3011-4ae4-8a4b-1a0f2dfd032c",
      "codigo": "01",
      "nombre": "CATEGORÍA EJEMPLO",
      "children": [
        {
          "id": "d8c7f26a-b1f7-47a3-8f5e-bdfd9f899b79",
          "codigo": "01.01",
          "nombre": "SUBCATEGORÍA 1",
          "children": [
            {
              "id": "1f73582d-7f7b-4f1f-8c9f-17a7fa3b4e37",
              "codigo": "01.01.001",
              "nombre": "ITEM DETALLADO 1"
            },
            {
              "id": "34e3b22b-9b78-4f8b-9c86-6f0f42f2f35a",
              "codigo": "01.01.002",
              "nombre": "ITEM DETALLADO 2"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "total_registros": 1,
    "pagina": 1,
    "total_paginas": 1
  }
}

Descripción de Campos de Respuesta

Campos principales

Campo	Tipo	Descripción
id	uuid	Identificador único de la clasificación.
codigo	string	Código estructurado que identifica la clasificación. Ej: “01”, “01.01”, “01.01.001”.
nombre	string	Nombre descriptivo de la clasificación de clientes.
children	array	Lista de subclasificaciones anidadas (estructura jerárquica).

Campos de paginación

Campo	Tipo	Descripción
total_registros	number	Cantidad total de clasificaciones en el sistema.
pagina	number	Número de página actual.
total_paginas	number	Cantidad total de páginas disponibles.

Recursos adicionales

Para obtener más información sobre posibles errores y cómo manejarlos, ruta la sección de errores.