List appointments
list_appointmentsA site's appointments, with times already written on the business's clock (and the visitor's own clock when it differs). view: "upcoming" (default), "pending" (waiting for the owner to confirm), "needs_time" (people who asked for an appointment and are waiting for the owner to pick a time — returned as requests), "past", "cancelled", or "registrations" / "enrolments" (event registrations / course enrolments, each with a claim_id, status, places and payment). Or pass week_of (any YYYY-MM-DD in the week) for a Monday–Sunday calendar: each day's open hours, time off and appointments. Personal data: never copy it into a site or anywhere the user did not ask.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | ||
| limit | No | ||
| site_id | Yes | The site, from list_sites | |
| week_of | No | Show that whole week (Mon–Sun) instead of a list | |
| user_goal | No | Optional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details. | |
| contact_id | No | Only this contact's appointments |