---
title: "Get a paged array of busy-times"
method: GET
path: "/busy-times"
tags: ["busy-time"]
---

# Get a paged array of busy-times

`GET /busy-times`

Get a paged array of busy-times

## Query parameters

- `id_gt` integer, nullable — The starting object id of the next page
- `id_lt` integer, nullable — The starting object id of the previous page
- `update_gt` union — Search for objects updated after this date time
  - string
  - string
- `update_lt` union — Search for objects updated before this date time
  - string
  - string
- `include_archived` 'true' | 'false', nullable — Whether archived objects should be retrieved, default is false
- `start_gt` union — Search for busy times that start after this date time
  - string
  - string
  - unknown
- `start_lt` union — Search for busy times thatstart before this date time
  - string
  - string
  - unknown
- `busyTimeTypeId` number, nullable — Search for busy times with this busy time type id
- `practitionerId` number, nullable — Search for busy times with this practitioner id

## Response `200`

A paged array of busy-times

- object
  - `data` object[], required
    - `id` integer, required — Busy time id
    - `start` union, required — Busy time start date time
      - string
      - string
    - `end` union, required — Busy time end date time
      - string
      - string
    - `locationId` integer, required — The location id of this busy time
    - `practitionerIds` integer[], required — The practitioner ids of this multiple practitioners busy time
    - `busyTimeTypeId` integer, nullable — The busy time type id of this multiple practitioners busy time
    - `repeatId` string, nullable, required — An recurring busy time will have this repeat id
    - `recurringRule` string, nullable, required — The rule for recurring busy time
    - `note` string, nullable, required — Busy time note
    - `archived` boolean, nullable — Whether the busy time type has been archived
    - `createdAt` union — Object creation date time
      - string
      - string
    - `updatedAt` union — Object update date time
      - string
      - string
    - `deletedAt` union, required — Object archived date time
      - string
      - string
      - unknown
  - `links` object, required
    - `previousPage` string — The link to retrieve next page
    - `nextPage` string — The link to retrieve previous page

---

[API](https://skmtc.dev/splose/apis/splose-public-api.md) · [All operations](https://skmtc.dev/splose/apis/splose-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/splose/splose-public-api/revisions/648d60075f00/schema)