Sign in

v1

latestOpenAPI 3.0.12026-08-062555238.4 KB
Store API endpoints

List branches

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

get/branches

Query parameters

page_numberinteger

The page number required

page_sizeinteger

Number of branches in one page

Headers

Authorizationstring required
User-Agentstring required
Brand-Idstring required

Response

Branches retrieved successfully

Example response

{
  "data": [
    {
      "id": "a34587b290784c06",
      "name": "KFC, JLT",
      "brand_id": "1228a02e60e34037",
      "state": "MAPPED",
      "created_at": "2020-06-22T15:01:32.895Z",
      "updated_at": "2020-06-22T15:01:32.895Z"
    }
  ],
  "meta": {
    "total": 90,
    "page_size": 20,
    "page_number": 1
  },
  "links": {
    "prev": "URL/api/branches?page_number=1&page_size=20",
    "next": "URL/api/branches?page_number=3&page_size=20"
  }
}