Slot

A slot is a time slot on a provider's schedule that can be booked by a patient.

The slot model

Properties

Name
generated_from_type
Type
string
Description
Whether this slot was generated from a provider's availability rule or availability override.
Possible values:
rule
override
Name
generated_from
Type
string
Description
Which rule or override this availability was generated from.
Name
start_time
Type
number
Description
Start time of slot in Unix epoch time (milliseconds).
Name
end_time
Type
number
Description
End time of slot in Unix epoch time (milliseconds).

Response

{
    "generated_from_type": "rule",
    "generated_from": "rule_Z1zXZKvqrpwxbznuW6lJ",
    "start_time": 1623153600000,
    "end_time": 1623157200000
}

GET/v2/slots

List all slots

Returns a list of all bookable slots for a patient and appointment type.

Required attributes

Name
appointment_type
Type
string
Description
Type of appointment to find slots for.
Name
patient
Type
string
Description
Patient to find slots for.
Name
search_from
Type
number
Description
Timestamp (in ISO 8601 format) to search from.
Name
search_until
Type
number
Description
Timestamp (in ISO 8601 format) to search until.

Response

{
  "object": "list",
  "data": [
    {
        "generated_from_type": "rule",
        "generated_from": "rule_Z1zXZKvqrpwxbznuW6lJ",
        "start_time": "2024-04-10T13:20:21.724Z",
        "end_time": "2024-04-10T13:40:21.724Z"
    },
  ]
}