> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar filiais

> Retorna a lista paginada de filiais da sua loja.

<ParamField path="app_id" type="string" required>
  O ID da sua loja no Jelou Shop.
</ParamField>

<ParamField query="page" type="integer" default="1">
  Número da página a retornar.
</ParamField>

<ParamField query="limit" type="integer" default="15">
  Quantidade de resultados por página (máx. 100).
</ParamField>

<ParamField query="paginate" type="boolean" default="true">
  Envie `false` para recuperar todas as filiais sem paginação.
</ParamField>

<Note>
  A listagem é ordenada por `created_at` ascendente. Para ordenar por outros campos (`name`, `code`, `updated_at`) use o endpoint [Buscar filiais](/pt/guias/integracoes/e-commerce/api-sucursales/buscar) com o parâmetro `sort`.
</Note>

## Campos da resposta

Cada filial em `data` contém os seguintes campos:

| Campo            | Tipo           | Descrição                                                   |
| ---------------- | -------------- | ----------------------------------------------------------- |
| `id`             | string         | UUID da filial                                              |
| `name`           | string         | Nome da filial                                              |
| `code`           | string         | Código único dentro da loja                                 |
| `address`        | string \| null | Endereço da filial                                          |
| `phone`          | string \| null | Telefone da filial                                          |
| `status`         | boolean        | Se a filial está ativa                                      |
| `properties`     | object \| null | Propriedades personalizadas (inclui `language` se definido) |
| `products_count` | integer        | Quantidade de produtos **ativos** associados à filial       |
| `created_at`     | string         | Data de criação                                             |
| `updated_at`     | string         | Data da última atualização                                  |

<RequestExample>
  ```bash cURL theme={null}
  curl "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches?page=1&limit=20" \
    -H "x-api-key: YOUR_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 Success theme={null}
  {
    "data": [
      {
        "id": "9e3f2c1a-8b7d-4e6f-a5c4-d3b2a1e0f9c8",
        "name": "Filial Centro",
        "code": "SUC-CENTRO",
        "address": "Av. Principal 123, Quito",
        "phone": "+593991234567",
        "status": true,
        "properties": {
          "language": "pt",
          "horario": "09:00 - 18:00"
        },
        "products_count": 42,
        "created_at": "2026-02-19T15:30:00.000000Z",
        "updated_at": "2026-02-19T15:30:00.000000Z"
      }
    ],
    "links": {
      "first": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches?page=1",
      "last": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/branches?page=1",
      "prev": null,
      "next": null
    },
    "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 1,
      "per_page": 15,
      "to": 1,
      "total": 1
    }
  }
  ```
</ResponseExample>