Search appointments
shopmonkey_search_appointmentsSearch the appointment calendar by date range, customer, order or technician. Returns appointments with their customer. Shopmonkey: POST /v3/appointment/search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Number of records to skip, for paging (use with limit). | |
| sort | No | Sort by start date. Default asc. | |
| endTo | No | Appointments ending at or before this ISO 8601 date-time. | |
| limit | No | Maximum number of records to return. | |
| endFrom | No | Appointments ending at or after this ISO 8601 date-time. | |
| orderId | No | Only appointments linked to this order. | |
| startTo | No | Appointments starting at or before this ISO 8601 date-time. | |
| startFrom | No | Appointments starting at or after this ISO 8601 date-time. | |
| customerId | No | Only this customer's appointments. | |
| technicians | No | Only appointments assigned to these technician (user) ids. | |
| includeUnassigned | No | With technicians, also include unassigned appointments. |