Buscar usuarios

Busca usuarios en el sistema usando criterios específicos. Útil para encontrar usuarios por nombre, email o WhatsApp.

---

Entorno

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

Endpoint

GET /usuarios/search?q={query}&page=1&limit=10

Ejemplo de solicitud

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

Nota: Asegúrate de reemplazar {query} por el parámetro 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 ruta

Parámetro	Tipo	Requerido	Descripción
query	string	Si	Parámetro de búsqueda
page	integer	No	Número de página. Por defecto: 1.
limit	integer	No	Resultados por página. Por defecto: 10

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": "7f5c3d42-9b1a-4e8c-921a-0a6d54c3fbc2",
      "email": "[email protected]",
      "nombre": "Juan Perez",
      "whatsapp": "+5491176543210"
    }
  ],
  "pagination": {
    "total_registros": 1,
    "pagina": 1,
    "total_paginas": 1
  }
}

Recursos adicionales

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