Actions17
Appointment → Get By Client Phone
AI-generatedSummary
Retrieve appointments matching a client's phone number, optionally filtering by status and appointment date range.
Inputs
- Client Phone (required) — Phone number of the client to search appointments. The number can be with or without formatting (e.g., (11) 99999-9999 or 11999999999).
- Additional Filters — Optional filters including Status (Scheduled, Confirmed, Completed, Canceled, No Show), Start Date (filter appointments from this date), and End Date (filter appointments until this date).
Output shape
a list of appointment objects matching the client phone and filters, if any
The operation returns up to 100 appointments that match the criteria. The client phone number is normalized by stripping non-digit characters before querying. Filters on status and date range are applied if provided. Errors may be included per item if continueOnFail is enabled.
