Skip to main content
GET
/
v1
/
scheduling
/
branches
/
{id}
Obtener detalle de una sucursal
curl --request GET \
  --url https://api.keebai.com/v1/scheduling/branches/{id} \
  --header 'Authorization: Bearer <token>'
Returns the requested branch as long as it belongs to the PAT’s tenant. The query filters by company in addition to _id, so a valid id from another tenant responds with 404.

Endpoint

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

Required scope

scheduling:branches:read

Path params

ParamTypeDescription
idstringBranch ObjectId.

Example request

curl https://api.keebai.com/v1/scheduling/branches/65a1f2b3c4d5e6f7a8b9c0d1 \
  -H "Authorization: Bearer kbai_pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 OK

{
  "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"
}

404 Not Found

{
  "error": {
    "code": "BRANCH_NOT_FOUND",
    "message": "Branch <id> no encontrado"
  }
}
A 404 is also returned when the id exists in another company.

401 Unauthorized · 403 Forbidden

Same semantics as the rest of the public API.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Response

200

Detalle de la sucursal