Skip to main content
POST
cURL
Search for open appointment times.

Request Body

  • search_from_date (required): The start date/time of the search in ISO 8601 format. Can be a present or future timestamp.
  • appointment_type (required): A string of the appointment type category. Available options: wellness, sick, technician, recheck.
This endpoint is currently proposed and subject to change. Functionality, request/response structure, and availability may be modified or removed in future releases. Use with caution in production environments.

Authorizations

Authorization
string
header
required

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

Headers

X-Client-Id
string
required

The location id of the practice

Body

application/json

Open times request

search_from_date
string<date-time>
required

The start date/time of the search in ISO 8601 format. Can be a present or future timestamp.

Example:

"2025-01-01T07:00:00Z"

appointment_type
enum<string>
required

An string of the appointment type category. Available options: wellness, sick, technician, recheck.

Available options:
wellness,
sick,
technician,
recheck

Response

Open times response

success
boolean
required
data
object[]
required
message
string