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

# List branches

> Returns the paginated list of branches in your store.

<ParamField path="app_id" type="string" required>
  Your store ID in Jelou Shop.
</ParamField>

<ParamField query="page" type="integer" default="1">
  Page number to return.
</ParamField>

<ParamField query="limit" type="integer" default="15">
  Number of results per page (max. 100).
</ParamField>

<ParamField query="paginate" type="boolean" default="true">
  Send `false` to retrieve all branches without pagination.
</ParamField>

<Note>
  The listing is ordered by `created_at` ascending. To sort by other fields (`name`, `code`, `updated_at`) use the [Search branches](/en/guides/integraciones/e-commerce/api-sucursales/buscar) endpoint with the `sort` parameter.
</Note>

## Response fields

Each branch in `data` contains the following fields:

| Field            | Type           | Description                                        |
| ---------------- | -------------- | -------------------------------------------------- |
| `id`             | string         | Branch UUID                                        |
| `name`           | string         | Branch name                                        |
| `code`           | string         | Unique code within the store                       |
| `address`        | string \| null | Branch address                                     |
| `phone`          | string \| null | Branch phone                                       |
| `status`         | boolean        | Whether the branch is active                       |
| `properties`     | object \| null | Custom properties (includes `language` if set)     |
| `products_count` | integer        | Number of **active** products linked to the branch |
| `created_at`     | string         | Creation date                                      |
| `updated_at`     | string         | Last update date                                   |

<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": "Downtown Branch",
        "code": "SUC-CENTRO",
        "address": "Av. Principal 123, Quito",
        "phone": "+593991234567",
        "status": true,
        "properties": {
          "language": "en",
          "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>