Get a paged array of appointments

Authorizations

Authorization

string

headerrequired

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

Query Parameters

id_gt

integer | null

The starting object id of the next page

id_lt

integer | null

The starting object id of the previous page

update_gt

Search for objects updated after this date time

update_lt

Search for objects updated before this date time

include_archived

enum<string> | null

default: false

Whether archived objects should be retrieved, default is false

Available options:

true,

false

start_gt

Search for appointments start after this date time

start_lt

Search for appointments start before this date time

patientId

number | null

Search for appointments with this patient id

status

enum<string> | null

Patient status of this appointment

Available options:

Arrived,

Did not arrive,

Cancelled

status_update_gt

Search for appointments status update after this date time

status_update_lt

Search for appointments status update before this date time

Response

200 - application/json

data

object[]

required

data.id

integer

required

Appointment id

Required range: x > 0

data.start

required

Appointment start date time

data.end

required

Appointment start date time

data.isUnavailableBlock

boolean | null

default: false

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

data.serviceId

integer | null

required

The service id of this appointment

Required range: x > 0

data.locationId

integer

required

The location id of this appointment

Required range: x > 0

data.practitionerId

integer

required

The practitioner id of this appointment

Required range: x > 0

data.maxPatients

integer

default: 1required

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

Required range: x > 0

data.caseId

integer | null

required

The case id of this appointment

Required range: x > 0

data.appointmentPatients

object[]

required

The status of each patient of this appointment

data.repeatId

string | null

required

An recurring appointment will have this repeat id

data.recurringRule

string | null

required

The rule for recurring appointment

data.unit

enum<string> | null

default: Hourrequired

The appointment unit

Available options:

Hour,

Each

data.pricing

number | null

required

The appointment unit price, in dollar

data.total

number | null

required

The appointment total price without tax, in dollar

data.taxType

required

Tax type, check Splose support for more info

Available options:

STANDARD,

ZERO,

EXEMPT,

REDUCED

data.supportItemIds

integer[]

required

Array of support item ids of this appointment

data.note

string | null

required

The appointment note

data.createdAt

required

Object creation date time

data.updatedAt

required

Object update date time

data.deletedAt

required

Object archived date time

links

object

required

Get started

API Reference

Authorizations

Query Parameters

Response