List appointments
list_appointmentsAppointments in a date range, with client, service, team member, price and status. Lists appointments that start between from and to (both days included; from defaults to today, to to from) as Sales > Appointments shows them, latest first: one row per booked service with its appointment id, reference, start (wall clock in the business's time zone), length, client, team member, price, status and channel (online or offline). Cancelled appointments are included with their status. location_id keeps one location of a business with several. Page with next_cursor. The report itself has no status, team member or client filter, so those three apply to the first 100 rows of the date range: for a busy range, narrow the dates.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_appointments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day of the range, included. Default: same as from. | |
| from | No | First day of the range (the day appointments start, YYYY-MM-DD). Default: today in the business's time zone. | |
| limit | No | Page size. Default: 50. | |
| cursor | No | next_cursor from the previous call. | |
| status | No | Only this status, as Fresha names it: booked, confirmed, arrived, started, completed, canceled, no-show. Default: all. | |
| client_id | No | Only this client's appointments. | |
| location_id | No | Only appointments at this location. Default: all. | |
| team_member_id | No | Only this team member's appointments. |