non_job_appointments_get_list
Retrieve a filtered list of non-job appointments from ServiceTitan based on criteria like date ranges, technician ID, or activity status, including pagination and sorting options for precise results.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
activeOnly | No | Whether the result should contains only active non-job appointments | |
createdBefore | No | Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC) | |
createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC) | |
ids | No | Perform lookup by multiple IDs (maximum 50) | |
includeTotal | No | Whether total count should be returned | |
modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC) | |
modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC) | |
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) | |
showOnTechnicianSchedule | No | Whether the non-job appointment shows on the technicians schedule even if there is no timesheet | |
sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, CreatedOn, ModifiedOn. | |
startsOnOrAfter | No | Format - date-time (as date-time in RFC3339). When the Start of non-job appointment should be at or after | |
startsOnOrBefore | No | Format - date-time (as date-time in RFC3339). When the Start of non-job appointment should be at or before | |
technicianId | No | Format - int64. Unique id of the technician this non-job appointment applies to | |
tenant | Yes | Format - int64. Tenant ID | |
timesheetCodeId | No | Format - int64. Unique Id of timesheet code must apply to |