Referencia de la APISucursales
Listar
Descripcion general
Este endpoint permite obtener un listado paginado de las sucursales pertenecientes a tu organización. Los resultados se devuelven en formato JSON e incluyen metadatos de paginación. Cada sucursal incluye su jerarquía mediante los campos parent_id y depth. Las sucursales eliminadas se excluyen automáticamente. El tamaño de página es fijo en 20 resultados.
Endpoint
GET
https://app.integranom.com/api/v1/branchesConsulta multiples sucursales
Query params
| Parametro | Tipo | Requerido | Default | Descripcion |
|---|---|---|---|---|
page | integer ≥ 1 | No | 1 | Página solicitada. El tamaño de página es fijo en 20. |
active | "true" | "false" | No | - | Filtra por el flag is_active. |
Consulta una sucursal especifica
Se puede buscar una sucursal particular por su número, nombre o código. Los tres filtros hacen coincidencia exacta; como los códigos se almacenan en mayúsculas, envía siempre el código en mayúsculas.
Query params
| Parametro | Tipo | Requerido | Default | Descripcion |
|---|---|---|---|---|
branch_number | integer | No | - | Filtra por número de sucursal exacto. |
name | string | No | - | Filtra por nombre exacto. |
code | string | No | - | Filtra por código exacto (almacenado en mayúsculas). |
Errores
| Status | Causa |
|---|---|
400 | Valor inválido en branch_number o active. |
401 | API key ausente o inválida. |
403 | La API key no tiene el permiso getBranches. |