List appointments
list_appointmentsRetrieve appointments for a date range, latest first, with client, service, team member, price, status, channel, and cancelled entries; page results with a cursor.
Instructions
Appointments in a date range, with client, service, team member, price and status.
Lists appointments 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. 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day. Default: same as from. | |
| from | Yes | First day. | |
| 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. | |
| team_member_id | No | Only this team member's appointments. |