---
title: "List branches"
method: GET
path: "/branches"
tags: ["Store API endpoints"]
---

# List branches

`GET /branches`

Use this endpoint to fetch all branches that you've created.

## Query parameters

- `page_number` integer
- `page_size` integer

## Headers

- `Authorization` string, required
- `User-Agent` string, required
- `Brand-Id` string, required

## Response `200`

Branches retrieved successfully

- BranchList — list of branches
  - `data` Branch[] — branch
    - `id` string, required — The id of the branch
    - `name` string, required — The name of the branch.
    - `brand_id` string, required — the parent brand id of this branch
    - `state` 'UNMAPPED' | 'MAPPED', required — The state of this branch.
    - `created_at` string, required — Time RFC3339 format in UTC in which the brand has been updated
    - `updated_at` string, required — Time RFC3339 format in UTC in which the brand has been updated
  - `meta` object — pagination meta data
    - `total` integer — total number of records in database
    - `page_size` integer — total number of records in the current page
    - `page_number` integer — The number of the current page
  - `links` object — links previous and next pagination pages
    - `prev` string — url of the previous page
    - `next` string — url of the next page

## Other responses

- `400` — Bad request

---

[API](https://skmtc.net/careemnow/apis/careem-pos-api.md) · [All operations](https://skmtc.net/careemnow/apis/careem-pos-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/careemnow/careem-pos-api/versions/374e3e0dddca/schema)