---
search:
  tags:
    - Branches
    - GET
seo:
  description: >-
    Any signed in user. Returns a page of branches ordered by name, with its
    trade… Reference for the GET /api/v1/branches endpoint in the PharmaFlow
    API.
sidebar:
  label: List branches
  badge: GET
title: List branches
type: openapi-operation
---
Any signed in user. Returns a page of branches ordered by name, with its trade currency. The list is active by default, so a closed branch comes back only when is_active is false or all.

`GET /api/v1/branches`

**Responses**

- `200` — A page of branches
- `401` — Not authenticated

Response example, 200:

```json
{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "city": "string",
      "vat_number": "string",
      "address": "string",
      "currency_code": "string",
      "image_url": "string",
      "is_active": true,
      "is_deleted": -9007199254740991,
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}
```