Get a paged array of appointments

Authorizations

Authorization

string

header

required

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

Example:

200

id_lt

integer | null

The starting object id of the previous page

Example:

100

update_gt

Search for objects updated after this date time

Example:

"2023-07-30T09:00:00.000Z"

update_lt

Search for objects updated before this date time

Example:

"2023-07-30T09:00:00.000Z"

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

Example:

"2023-07-30T09:00:00.000Z"

start_lt

Search for appointments start before this date time

Example:

"2023-07-30T09:00:00.000Z"

patientId

number | null

Search for appointments with this patient id

Example:

1

status

enum<string> | null

Patient status of this appointment

Available options:

Arrived,

Did not arrive,

Cancelled,

Completed

status_update_gt

Search for appointments status update after this date time

Example:

"2023-07-30T09:00:00.000Z"

status_update_lt

Search for appointments status update before this date time

Example:

"2023-07-30T09:00:00.000Z"

Response

200 - application/json

A paged array of appointments

data

object[]

required

Show child attributes

data.id

integer

required

Appointment id

Required range: x > 0

Example:

1

data.start

required

Appointment start date time

Example:

"2023-07-30T09:00:00.000Z"

data.end

required

Appointment end date time

Example:

"2023-07-30T09:00:00.000Z"

data.serviceId

integer | null

required

The service id of this appointment

Required range: x > 0

Example:

1

data.locationId

integer

required

The location id of this appointment

Required range: x > 0

Example:

1

data.practitionerId

integer

required

The practitioner id of this appointment

Required range: x > 0

Example:

1

data.maxPatients

integer

default:1

required

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

Required range: x > 0

data.appointmentPatients

object[]

required

The status of each patient of this appointment

Show child attributes

data.appointmentPatients.appointmentId

integer

required

Appointment id

Required range: x > 0

Example:

1

data.appointmentPatients.patientId

integer

required

Patient id

Required range: x > 0

Example:

1

data.appointmentPatients.caseId

integer | null

required

The case id of this appointment

Required range: x > 0

Example:

1

data.appointmentPatients.status

enum<string> | null

required

Patient status of this appointment

Available options:

Arrived,

Did not arrive,

Cancelled,

Completed

data.appointmentPatients.note

string | null

required

Note for the appointment patient

Example:

"Some notes"

data.appointmentPatients.invoiceId

integer | null

required

Invoice id of this appointment patient

Required range: x > 0

Example:

1

data.appointmentPatients.cancellationReason

string | null

required

The cancellation reason if the appointment is cancelled

Example:

"Other"

data.appointmentPatients.cancellationRate

number | null

required

The billable rate in percentage if the appointment is cancelled

Example:

30

data.appointmentPatients.cancellationNote

string | null

required

The cancellation note if the appointment is cancelled

Example:

"Some notes"

data.appointmentPatients.statusUpdatedAt

required

The status update time

Example:

"2023-07-30T09:00:00.000Z"

data.appointmentPatients.doNotInvoice

boolean | null

default:false

Whether this appointment patient will not be invoiced

data.repeatId

string | null

required

An recurring appointment will have this repeat id

Example:

"12345678-abcd-4321-dcba-12a34b56c78d"

data.recurringRule

string | null

required

The rule for recurring appointment

Example:

"DTSTART:2023080T010000ZRRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=6"

data.unit

enum<string> | null

default:Hour

required

The appointment unit

Available options:

Hour,

Each

data.pricing

number | null

required

The appointment unit price, in dollar

Example:

193.99

data.total

number | null

required

The appointment total price without tax, in dollar

Example:

193.99

data.taxType

required

Tax type, check Splose support for more info

Available options:

STANDARD,

ZERO,

EXEMPT,

REDUCED

Example:

"STANDARD"

data.supportItemIds

integer[]

required

Array of support item ids of this appointment

Required range: x > 0

Example:

[1]

data.note

string | null

required

The appointment note

Example:

"Some notes"

data.deletedAt

required

Object archived date time

Example:

"2023-07-30T09:00:00.000Z"

data.isUnavailableBlock

boolean | null

default:false

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

data.archived

boolean | null

default:false

Whether the appointment has been archived

data.createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

data.updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"

links

object

required

Show child attributes

links.previousPage

string

The link to retrieve next page

Example:

"/v1/${object_type}?id_gt=200"

links.nextPage

string

The link to retrieve previous page

Example:

"/v1/${object_type}?id_lt=100"

Get started

API Reference

Authorizations

Query Parameters

Response