Skip to main content
Get a paged array of busy-times
curl --request GET \
  --url https://api.splose.com/v1/busy-times \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "start": "2023-07-30T09:00:00.000Z",
      "end": "2023-07-30T09:00:00.000Z",
      "locationId": 1,
      "practitionerIds": [
        1
      ],
      "repeatId": "12345678-abcd-4321-dcba-12a34b56c78d",
      "recurringRule": "DTSTART:2023080T010000ZRRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=6",
      "note": "Daily stand-up",
      "deletedAt": "2023-07-30T09:00:00.000Z",
      "busyTimeTypeId": 1,
      "archived": false,
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id_gt
integer | null

The starting object id of the next page

Example:

200

​
id_lt
integer | null

The starting object id of the previous page

Example:

100

​
update_gt

Search for objects updated after this date time

Example:

"2023-07-30T09:00:00.000Z"

​
update_lt

Search for objects updated before this date time

Example:

"2023-07-30T09:00:00.000Z"

​
include_archived
enum<string> | null
default:false

Whether archived objects should be retrieved, default is false

Available options:
true,
false
​
start_gt

Search for busy times that start after this date time

Example:

"2023-07-30T09:00:00.000Z"

​
start_lt

Search for busy times thatstart before this date time

Example:

"2023-07-30T09:00:00.000Z"

​
busyTimeTypeId
number | null

Search for busy times with this busy time type id

Response

200 - application/json

A paged array of busy-times

​
data
object[]
required
​
links
object
required