latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Returns the Appointment Request identified by the ID.

get/Business/Schedules/AppointmentRequests/{id}

Path parameters

idinteger required

The appointment request ID

Headers

Authorizationstring required

Bearer {user_token}

SiteIdinteger required

Site ID

Response

OK

Idinteger

Request unique identifier

StartDateTimestring date-time

Start date time of the appointment

EndDateTimestring date-time

End date time of the appointment

Status'Booked' | 'Completed' | 'Confirmed' | 'Arrived' | 'NoShow' | 'Cancelled'

Return the appointment status. TODO: this should replace the status fields above.

ProgramIdinteger

Program unique identifier

SessionTypeIdinteger

Session type unique identifier

PrepTimeinteger

Prep time for the appointment

FinishTimeinteger

Finish time for the appointment

StaffIdinteger

Appointment staff

ClientIdinteger

Appointment client

LocationIdinteger

Location unique identifier for the appointment

ClientNamestring

Client for the appointment request

ClientFormattedNameForSchedulestring

Client name for the appointment request, formatted for schedule view

ClientHomePhonestring

Client home phone number

ClientMobilePhonestring

Client mobile phone number

ClientWorkPhonestring

Client work phone number

ClientEmailstring

Client email

StaffProviderIdinteger

Staff provider unique identifier

MemberIconinteger

Membership icon

MemberDetailsstring

Membership details

RequestedStaffIdinteger

Staff that requested the appointment

SystemClientboolean

Whether the client is a system generated client

Arrivedboolean

Whether the client has arrived for the appointment or not

Confirmedboolean

Whether the client has confirmed the appointment or not

Completedboolean

Whether the client has completed the appointment or not

BookedOnlineboolean

Whether the request was booked online or not

FinderAppointmentboolean

Whether the appointment was booked on Finder or not

PaymentAppliedboolean

Whether a payment was applied or not

Capacityinteger

Capacity of the appointment

Notesstring

Notes, if any, for this Appointment request

ReservedForstring

Reserved for, if any

ReservedByClientIdinteger

Client's unique identifier who reserved the appointment, if any

ReservedByClientNamestring

Client's name who reserved the appointment, if any

Recurringboolean

Whether the appointment is recurring or not

GenderPreference'None' | 'Male' | 'Female'

Gender preference of the client

ResourceIdsinteger[]

Resources for the appointment

BookedByIdinteger

Staff that booked the appointment

BookedDateTimestring date-time

Date time of the appointment

ModifiedByIdinteger

Staff that modified the appointment

ModifiedDateTimestring date-time

Date time of the last time the appointment request was modified

ConfirmedByIdinteger

Confirmed by

ConfirmedDateTimestring date-time

Date time for the confirmation of the appointment