Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
integer
required

Response

200 - application/json
id
integer
required

Appointment id

start
required

Appointment start date time

end
required

Appointment start date time

isUnavailableBlock
boolean | null
default: false

Whether this time slot is unavailable, eg. busy time or meeting

serviceId
integer | null
required

The service id of this appointment

locationId
integer
required

The location id of this appointment

practitionerId
integer
required

The practitioner id of this appointment

maxPatients
integer
default: 1required

The max patient number of this appointment. A number greater than 1 indicates a group appointment.

appointmentPatients
object[]
required

The status of each patient of this appointment

repeatId
string | null
required

An recurring appointment will have this repeat id

recurringRule
string | null
required

The rule for recurring appointment

unit
enum<string> | null
default: Hourrequired

The appointment unit

Available options:
Hour,
Each
pricing
number | null
required

The appointment unit price, in dollar

total
number | null
required

The appointment total price without tax, in dollar

taxType
required

Tax type, check Splose support for more info

Available options:
STANDARD,
ZERO,
EXEMPT,
REDUCED
supportItemIds
integer[]
required

Array of support item ids of this appointment

note
string | null
required

The appointment note

createdAt
required

Object creation date time

updatedAt
required

Object update date time

deletedAt
required

Object archived date time

Get a paged array of appointmentsUpdate start and end for one appointment