Saltearse al contenido

Obtener una lista de los usuarios

Lista todos los usuarios registrados en el sistema de forma paginada. Permite gestionar y visualizar los usuarios.


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

GET /usuarios?page=1&limit=100
Ventana de terminal
curl -X GET "https://api.guarani.app/usuarios?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ámetroTipoRequeridoDescripción
pageintegerNoNúmero de página. Por defecto: 1.
limitintegerNoResultados por página. Por defecto: 10.
EncabezadoValorDescripción
x-api-keyBearer <access_token>Token de autenticación necesario para acceder al recurso.
Acceptapplication/jsonIndica que la respuesta debe devolverse en formato JSON.
{
"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
}
}

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