Skip to main content
GET
/
v1
/
organisations
/
{organisationId}
/
bookings
/
availability
Get booking availability
curl --request GET \
  --url https://api.halth.com/v1/organisations/{organisationId}/bookings/availability
{
  "timeslots": [
    {
      "providers": [
        "1",
        "2",
        "3"
      ],
      "appointmentTime": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.halth.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
organisationId
string
required

Query Parameters

​
providerId
string

If not supplied, then all providers for the location/appointment type will be queried for availability

​
locationId
string
required
​
appointmentTypeId
string
required
​
searchDateMin
string<date-time>
required
​
searchDateMax
string<date-time>
required

Response

200 - application/json
​
timeslots
object[]
required