# Listar (/docs/developers/api-reference/branches/list)

## Descripcion general [#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 [#endpoint]

`GET https://app.integranom.com/api/v1/branches`

## Consulta multiples sucursales [#consulta-multiples-sucursales]

***

## Query params [#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`.                       |

**cURL**

```bash
curl -X GET "https://app.integranom.com/api/v1/branches" \
-H "Authorization: Bearer TU_API_KEY" \
-H "Content-Type: application/json"
```

**Respuesta**

```json
{
"count": 42,
"page": 1,
"page_size": 20,
"total_pages": 3,
"next": "https://app.integranom.com/api/v1/branches?page=2",
"previous": null,
"results": [
  {
    "branch_number": 1,
    "parent_id": null,
    "depth": 0,
    "name": "Matriz CDMX",
    "code": "CDMX",
    "description": "Oficinas centrales",
    "is_active": true,
    "sort_order": 0,
    "created_at": "2026-05-24T12:34:56.000Z",
    "updated_at": "2026-05-24T12:34:56.000Z"
  }
]
}
```

## Consulta una sucursal especifica [#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 [#query-params-1]

| 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). |

**cURL**

```bash
curl -X GET "https://app.integranom.com/api/v1/branches?branch_number=1" \
-H "Authorization: Bearer TU_API_KEY" \
-H "Content-Type: application/json"
```

**Respuesta**

```json
{
"count": 1,
"page": 1,
"page_size": 20,
"total_pages": 1,
"next": null,
"previous": null,
"results": [
  {
    "branch_number": 1,
    "parent_id": null,
    "depth": 0,
    "name": "Matriz CDMX",
    "code": "CDMX",
    "description": "Oficinas centrales",
    "is_active": true,
    "sort_order": 0,
    "created_at": "2026-05-24T12:34:56.000Z",
    "updated_at": "2026-05-24T12:34:56.000Z"
  }
]
}
```

## Errores [#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`. |