Buscar clasificaciones de servicios

Busca clasificaciones de servicios usando criterios específicos. Útil para encontrar categorías por código o nombre.

---

Entorno

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

Endpoint

GET /servicios-clasificaciones/search?q={query}&page=1&limit=100

Ejemplo de solicitud

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

Nota: Asegúrate de reemplazar {query} por el parametro a buscar y <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 consulta

Parámetro	Tipo	Requerido	Descripción
query	string	Sí	Parámetro de busqueda
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"
    }
  ],
  "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 servicios.

Campos de paginación

Campo	Tipo	Descripción
total_registros	number	Cantidad total de clasificaciones que coinciden con la búsqueda.
pagina	number	Número de página actual.
total_paginas	number	Cantidad total de páginas disponibles.

Recursos adicionales

Para más información sobre posibles errores y cómo manejarlos, consulta errores.