search_appointments
Find appointments using filters like status, route, office, customer, or date, and receive the matching appointment IDs.
Instructions
Search for appointments and return matching IDs. Maps to POST /appointment/search. [tier: readonly-owner]
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": "search_appointments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | 0: Pending, 1: Completed, 2: No Show, -1: Cancelled, -2: Rescheduled | |
| routeIDs | No | ||
| officeIDs | No | ||
| customerIDs | No | ||
| includeData | No | ||
| dateAddedEnd | No | ||
| extra_filters | No | ||
| appointmentIDs | No | ||
| dateAddedStart | No | ||
| subscriptionIDs | No | ||
| dateCompletedEnd | No | ||
| dateCompletedStart | No |