jobs_get_list
Retrieve filtered job lists from ServiceTitan by specifying criteria like appointment dates, status, customer ID, or priority for efficient job management and tracking.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| appointmentStartsBefore | No | Format - date-time (as date-time in RFC3339). Return jobs if any appointment starts after date/time (in UTC) | |
| appointmentStartsOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return jobs if any appointment starts after date/time (in UTC) | |
| appointmentStatus | No | Filters by appointment status. Return a job if it has any appointment with the specified status. Values: [Scheduled, Dispatched, Working, Hold, Done, Canceled] | |
| bookingId | No | Format - int64. Filters by booking ID that resulted in this job | |
| businessUnitId | No | Format - int64. Filters by job's business unit ID | |
| campaignId | No | Format - int64. Filters by job's campaign ID | |
| completedBefore | No | Format - date-time (as date-time in RFC3339). Return jobs that are completed before a certain date/time (in UTC) | |
| completedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return jobs that are completed after a certain date/time (in UTC) | |
| 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) | |
| customerId | No | Format - int64. Filters by job's customer ID | |
| externalDataApplicationGuid | No | Format - guid. If this guid is provided, external data corresponding to this application guid will be returned. | |
| externalDataKey | No | Performs lookup by external data key, 'externalDataValues' must also be provided. | |
| externalDataValues | No | Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided. | |
| firstAppointmentStartsBefore | No | Format - date-time (as date-time in RFC3339). Return jobs whose first appointment starts before date/time (in UTC) | |
| firstAppointmentStartsOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return jobs whose first appointment starts on or after date/time (in UTC). Use with "firstAppointmentStartsBefore" to find jobs whose first appointment is within the specified date range. | |
| hasUnusedAppointments | No | If set to true, return jobs that have unused appointments. | |
| ids | No | Perform lookup by multiple IDs (maximum 50) | |
| includeTotal | No | Whether total count should be returned | |
| invoiceId | No | Format - int64. Filters by job's invoice ID | |
| jobStatus | No | Filters by job status Values: [Scheduled, Dispatched, InProgress, Hold, Completed, Canceled] | |
| jobTypeId | No | Format - int64. Filters by job type ID | |
| locationId | No | Format - int64. Filters by job's location ID | |
| 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) | |
| number | No | Filters by job 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) | |
| priority | No | Filters by priority. Supported priorities are "Low", "Normal", "High", "Urgent" | |
| projectId | No | Format - int64. Filters by project ID | |
| soldById | No | Format - int64. Filters by the technician who sold the job | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn, Priority. | |
| tagTypeIds | No | Return jobs that have at least one of provided Tag Type assigned | |
| technicianId | No | Format - int64. Return jobs if technician is assigned to any appointment | |
| tenant | Yes | Format - int64. Tenant ID |