v1

latestOpenAPI 3.0.02026-07-26550199.6 KB

busy-time

Get a single busy-time

Get busy-time data by id

get/busy-times/{id}

Path parameters

idinteger required

Example:1

Response

Object with busy-time data.

idinteger required

Busy time id

locationIdinteger required

The location id of this busy time

practitionerIdsinteger[] required

The practitioner ids of this multiple practitioners busy time

busyTimeTypeIdinteger nullable

The busy time type id of this multiple practitioners busy time

repeatIdstring nullable required

An recurring busy time will have this repeat id

recurringRulestring nullable required

The rule for recurring busy time

notestring nullable required

Busy time note

archivedboolean nullable

Whether the busy time type has been archived

Example response

{
  "id": 1,
  "locationId": 1,
  "practitionerIds": [
    1
  ],
  "busyTimeTypeId": 1,
  "repeatId": "12345678-abcd-4321-dcba-12a34b56c78d",
  "recurringRule": "DTSTART:2023080T010000ZRRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=6",
  "note": "Daily stand-up"
}