← API REST v1 SECCIÓN DEL MANUAL

4. Formato de respuesta

Instrucciones, comprobaciones y pasos de esta sección del manual.

Prueba esta ruta en el laboratorio

Abre el laboratorio estilo Postman, indica la URL de tu panel y envía la petición. Recuerda activar la API en Ajustes → Gestión de personal.

Éxito

{ "ok": true, "data": {}, "meta": { "page": 1, "per_page": 25, "total": 10, "last_page": 1 } }

meta solo aparece en listados paginados.

Error

{ "ok": false, "error": { "code": "forbidden", "message": "No tienes permiso para esta operación.", "permission": "clientes.usuarios.menu" } }
HTTP code
401 unauthenticated, invalid_credentials
403 forbidden, api_disabled, operator_disabled
404 not_found
422 validation_error, payment_failed, pdf_unavailable

Paginación, filtros y rate limit

Query string de los listados:

  • page (default 1)
  • per_page (default 25, máximo 100)
  • Filtros propios de cada listado (q, status, customer_id, etc.)

Límites:

  • Login: 20 peticiones / minuto
  • Rutas autenticadas: 60 / minuto en lecturas y 20 / minuto en el grupo de recursos