appointments_getlist
Retrieve a list of appointments from ServiceTitan based on criteria like job ID, customer ID, technician ID, status, or date ranges. Supports filtering, sorting, and pagination for targeted data extraction.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| createdBefore | No | Format - date-time (as date-time in RFC3339). Return appointments created before a certain date/time (in UTC) | |
| createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return appointments created on or after a certain date/time (in UTC) | |
| customerId | No | Format - int64. Return appointments for the specified Customer | |
| ids | No | Perform lookup by multiple IDs (maximum 50) | |
| includeTotal | No | Whether total count should be returned | |
| jobId | No | Format - int64. Return all appointments for this job | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return appointments modified before a certain date/time (in UTC) | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return appointments modified on or after a certain date/time (in UTC) | |
| number | No | Return all appointments with this appointment number | |
| page | No | Format - int32. The logical number of page to return, starting from 1 | |
| pageSize | No | Format - int32. How many records to return (50 by default) | |
| projectId | No | Format - int64. Return all appointments for jobs that are part of this project | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn. | |
| startsBefore | No | Format - date-time (as date-time in RFC3339). Return appointments that start before the specified date/time (in UTC) | |
| startsOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return appointments that start on or after the specified date/time (in UTC) | |
| status | No | Return items with specified status AppointmentStatus Values: [Scheduled, Dispatched, Working, Hold, Done, Canceled] | |
| technicianId | No | Format - int64. Return appointments this technician is assigned to | |
| tenant | Yes | Format - int64. Tenant ID | |
| unused | No | Return appointments that are unused |