API Reference

List appointments

get
http://api-gateway-eu.phorest.com/third-party-api-server/api/business//branch//appointment

Get a list of appointments for the specified business id and branch id, with a maximum one month date range. List can be filtered by date of appointment, DateTime of update, staff id, room id, machine id or client id with possibility to include canceled, deleted or archived appointments and option to fetch online categories and notes of appointments

Path Params
string
required
string
required
Query Params
date

from date to query from. yyyy-MM-dd

date

to date (inclusive) to query to. yyyy-MM-dd

string

staff id to filter by

string

room id to filter by

string

machine id to filter by

string

client id to filter by

boolean

include canceled appointments in the list

boolean

include deleted appointments in the list

boolean

include archived appointments in the list

string

date-time from which the appointments has been updated onwards

string

date-time to which the appointments has been updated backwards

boolean

include online categories of appointments

boolean

include notes of appointments

string

group booking id to filter by

integer
Defaults to 20

number of appointments to return, max is 100

integer
Defaults to 0

page number, default is 0 and is optional

Responses

Updated 7 months ago

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