SPsplose
busy-time

Get a paged array of busy-times

Get a paged array of busy-times

get/busy-times

Request

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

string
OR
string
OR
unknown
string
OR
string
OR
unknown
busyTimeTypeIdnumber nullable

Search for busy times with this busy time type id

practitionerIdnumber nullable

Search for busy times with this practitioner id

Example:1

Response

A paged array of busy-times

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.