List Appointments

GET

/businesses/{businessId}/appointments

• production

List Appointments within a Business

Authorizations

• apiKey

Parameters

Path Parameters

businessId

required

string format: uuid

Business ID

Query Parameters

startDate

required

string format: date-time

Start of date range

endDate

required

string format: date-time

End of date range

patientId

string format: uuid

ID of the patient to filter appointments by

Responses

200

A list of Appointments

object

data

Array<object>

Appointment

A booked time slot between Staff(s), Patient, and potential resources.

object

id

required

Unique identifier across the platform.

string format: uuid

createdAt

required

Time when the resource was created (ISO 8601 format).

string format: date-time

updatedAt

required

Time when the resource was created (ISO 8601 format).

string format: date-time

service

required

Embedded service details

object

id

Unique identifier across the platform.

string format: uuid

name

The name of the service.

string

alias

The unique alias of the service.

string

staff

required

Embedded staff member details

object

id

Unique identifier across the platform.

string format: uuid

name

The full name of the Staff member.

string

email

The email address of the Staff member.

string

patient

required

Embedded patient details

object

id

Unique identifier across the platform.

string format: uuid

name

The full name of the patient.

string

email

The email address of the patient.

string

location

Embedded location details

object

id

Unique identifier across the platform.

string format: uuid

name

The name of the location.

string

address

The address of the location.

string

serviceId

required

Staff ID

string format: uuid

staffId

required

Staff ID

string format: uuid

staffName

required

The full name of the Staff member.

string

Example

John Doe

additionalStaffIds

An optional list of extra Staff IDs for group bookings.

Array<string>

patientId

required

Staff ID

string format: uuid

date

required

The start time of the appointment in UTC format.

string

originalDate

The date of the appointment before any rescheduling.

string

nullable

duration

required

How long the appointment lasts for.

number format: int32

price

required

The price of the appointment at the time of booking.

number format: int32

currency

The ISO 4217 currency code.

string

Example

usd

groupBookingId

Staff ID

string format: uuid

nullable

cancelled

Show whether or not this appointment has been cancelled.

boolean

nullable

approved

required

Show whether or not this appointment has been approved.

boolean

patientTimezone

The timezone of the patient.

string

nullable

Example

Europe/London

locationType

The type of location for the appointment.

string

nullable

Example

meet

locationValue

The value of the location for the appointment.

string

nullable

Example

https://meet.google.com/abc-defg-hij

paymentProvider

The payment provider used for the appointment.

string

nullable

Example

stripe

paymentId

The payment ID for the appointment.

string

nullable

answers

The answers to the questions asked during booking.

Array<object>

nullable

object

id

required

The unique ID for the question

string

variableName

The unique variable name assigned to ths question

string

question

required

The question asked during booking

string

answer

required

The answer given during booking

string | number

recurringAppointmentId

The ID of the recurring appointment this appointment belongs to.

string format: uuid

nullable

rrule

The rrule string if appointment is recurring.

string

nullable

Example

FREQ=WEEKLY;BYDAY=MO,WE,FR;INTERVAL=1;COUNT=10

recurrence

The recurrence object if appointment is recurring.

object

rescheduleUrl

required

The reschedule URL for the appointment.

string

Example

https://forms.upvio.com/acme/appointments/9222ea2b-34a4-477f-9568-35f7ee222f0c/reschedule?token=a9b0ca6781ca47bf80f97bdea29b0862

cancelUrl

required

The reschedule URL for the appointment.

string

Example

https://forms.upvio.com/acme/appointments/9222ea2b-34a4-477f-9568-35f7ee222f0c/cancel?token=a9b0ca6781ca47bf80f97bdea29b0862

tags

A list of tags associated with the appointment.

Array<string>