List branches

The seller’s branches that are not deleted, sorted by name. Staff (shops.read) see all of them, each with its assigned users and their role. A user with only sellers.read (the vendedor role) sees just the branches they are assigned to, without the users: that is how a dealer app finds its own sucursal.

GET/shops/{shop_id}/branches

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

shop_idintegerrequired

Query parameters

qstring

Search in the name.

namestring

typestring

Allowed:StoreOfficeWarehousePickupPoint

sortstring

name, id or created_at, with .asc or .desc (default name.asc).

pageinteger

per_pageinteger

max 250

Responses

200

Paginated list under _embedded.items

403

Access denied

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idpath*qquerySearch in the name.namequerytypequerysortquery`name`, `id` or `created_at`, with `.asc` or `.desc` (default `name.asc`).pagequeryper_pagequery

Request

curl -X GET 'https://api.onbolder.com/v2/shops/1/branches' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/shops/1/branches", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/shops/1/branches",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_class": [
    "results",
    "branches"
  ],
  "total_items": 1,
  "_embedded": {
    "items": [
      {
        "id": 12,
        "name": "BYD · Las Condes",
        "type": "Office",
        "status": "hidden",
        "_embedded": {
          "users": [
            {
              "id": 31,
              "name": "Camila Rojas",
              "email": "camila.rojas@example.cl",
              "role": "vendedor"
            }
          ]
        }
      }
    ]
  }
}