Listar establecimientos
GET /api/establishments
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Lista los establecimientos ordenados por id, con paginación por cursor.
Quién puede usarlo: solo usuarios de tipo administrador (type = admin). Con el token de un vendedor responde 403.
Paginación por cursor: envía limit (1 a 100, por defecto 15). La respuesta trae pagination.next_cursor; para la página siguiente repite la misma consulta agregando cursor=<next_cursor>. Cuando pagination.has_more es false no hay más páginas.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
search |
query | no | Busca por nombre (description) o código (code). |
|
limit |
query | no | 15 |
Registros por página, de 1 a 100. Por defecto 15. |
cursor |
query | no | Valor de pagination.next_cursor de la respuesta anterior para obtener la página siguiente. |
Respuestas
200 — Listado
{
"success": true,
"data": [
{
"id": 2,
"description": "SUCURSAL MIRAFLORES",
"country_id": "PE",
"department_id": "15",
"province_id": "1501",
"district_id": "150122",
"address": "AV. LARCO 456",
"addresses": [],
"telephone": "014445566",
"email": "miraflores@empresa.com",
"code": "0001",
"trade_address": "AV. LARCO 456 - MIRAFLORES",
"web_address": "https://empresa.com",
"aditional_information": "Horario: lunes a sábado de 9 a 18 h",
"customer_id": null,
"customer_number": null,
"logo": null,
"has_igv_31556": false,
"template_pdf": "default",
"template_ticket_pdf": "default",
"department": "LIMA",
"province": "LIMA",
"district": "MIRAFLORES",
"warehouse_id": 2
}
],
"pagination": {
"next_cursor": null,
"has_more": false
}
}
403 — Usuario no administrador
{
"success": false,
"message": "Solo un administrador puede gestionar este recurso."
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.