API Reference

List appointment availabilities

post
http://api-gateway-eu.phorest.com/third-party-api-server/api/business//branch//appointments/availability

Get a list of available appointment times for the specified business id and branch id, within the specified date range for the specified services

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params

Details of the required appointment

string

The unique client identifier

date-time
required

The earliest time to consider an available appointment in ISO 8601 format

date-time
required

The latest time to consider an available appointment in ISO 8601 format

clientServiceSelections
array of objects
required

List of services, grouped by the client who selected those services, for which availability should be checked. Currently only service selections for a single client will be accepted

clientServiceSelections*
string

The id of an existing appointment, if the request is being made to find availability in order to reschedule that existing appointment

boolean

Fetch staff available online

Responses

Updated 9 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago