Skip to main content
GET
/
v1
/
scheduling
/
branches
Listar sucursales activas del tenant
curl --request GET \
  --url https://api.keebai.com/v1/scheduling/branches \
  --header 'Authorization: Bearer <token>'
Returns branches with status: active for the tenant resolved from the PAT. Search uses the branch_text_search text index (language spanish), so it tolerates plurals and accents.

​
Endpoint

GET https://api.keebai.com/v1/scheduling/branches

​
Required scope

scheduling:branches:read

​
Headers

HeaderRequiredValue
AuthorizationYesBearer kbai_pk_<token>

​
Query params

ParamTypeDefaultDescription
searchstring—Full-text search over name and display_name.
skipnumber0Pagination offset. Minimum 0.
limitnumber50Page size. Range 1..200.

​
Example request

curl -G https://api.keebai.com/v1/scheduling/branches \
  -H "Authorization: Bearer kbai_pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  --data-urlencode "search=clinica norte" \
  --data-urlencode "limit=20"

​
Response

​
200 OK

{
  "total": 3,
  "skip": 0,
  "limit": 20,
  "items": [
    {
      "id": "65a1f2b3c4d5e6f7a8b9c0d1",
      "name": "Clínica Norte",
      "display_name": "Norte",
      "description": "Sede principal en Vitacura",
      "address": {
        "street": "Av. Apoquindo 1234",
        "city": "Santiago",
        "region": "RM",
        "country": "CL"
      },
      "contact": { "phone": "+56229999999", "email": "norte@clinica.cl" },
      "timezone": "America/Santiago",
      "status": "active"
    }
  ]
}
FieldTypeDescription
totalnumberTotal branches matching the filters (before pagination).
items[].idstringBranch ObjectId. Used as branch_id for availability and appointments.
items[].timezonestringBranch timezone. All availability and appointments are computed against this tz.

​
401 Unauthorized

Token missing, invalid, revoked, or expired.

​
403 Forbidden

The token doesn’t have the scheduling:branches:read scope.

Authorizations

​
Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Query Parameters

​
search
string

Búsqueda libre por nombre

​
skip
number
default:0
Required range: x >= 0
​
limit
number
default:50
Required range: 1 <= x <= 200

Response

200

Listado paginado de sucursales