List active branches

GET

/v1/branches

Returns every active branch belonging to the authenticated company, each with its
live open/closed status. This is normally the first call in a booking flow: pick a
branch, then read its service tree with GET /branches/{branchId}/tree.

When to use — Render a branch picker, or resolve a branch's live isBranchOpen
status before letting a user book.

Prerequisites — A valid public or secret key. No parameters.

Behavioural notes

Only branches with active: true are returned. Inactive/archived branches are hidden.

branchStatus.isBranchOpen is computed live from the branch's timing group at request
time and reflects the company's timezone.

Branch name is localized to X-Locale when a translation exists.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Responses

🟢200

application/json

Branches fetched successfully.

Bodyapplication/json

🟠401Unauthorized

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/branches' \
--header 'X-Locale;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Branches fetched successfully.",
    "data": {
        "branches": [
            {
                "id": "802b33af66",
                "name": "Seef Mall Branch",
                "addressLine": "Seef District, Manama, Bahrain",
                "location": {
                    "lat": 26.2361,
                    "lng": 50.5436
                },
                "group": {
                    "id": "grpseef0001",
                    "name": "Capital Region"
                },
                "branchStatus": {
                    "isBranchOpen": true
                }
            },
            {
                "id": "a1c4e9f2b7",
                "name": "Riffa Branch",
                "addressLine": "East Riffa, Bahrain",
                "location": {
                    "lat": 26.13,
                    "lng": 50.555
                },
                "group": {
                    "id": "grpriffa01",
                    "name": "Southern Region"
                },
                "branchStatus": {
                    "isBranchOpen": false
                }
            }
        ]
    }
}

Get a branch's service tree