projects_get_list
Retrieve a filtered list of projects from ServiceTitan by specifying criteria like date ranges, customer ID, project status, or manager IDs. Supports pagination and sorting for efficient data access.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| appointmentId | No | Format - int64. Return project if it contains the specified appointment in the project's jobs | |
| businessUnitIds | No | Returns projects which have at least one of the provided business units assigned | |
| completedBefore | No | Format - date-time (as date-time in RFC3339). Return projects that are completed before date | |
| completedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return projects that are completed on or after date | |
| 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 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. | |
| ids | No | Perform lookup by multiple IDs (maximum 50) | |
| includeTotal | No | Whether total count should be returned | |
| invoiceId | No | Format - int64. Return projects if it contains the specified invoice | |
| jobId | No | Format - int64. Return project if it contains the specified job | |
| locationId | No | Format - int64. Filters by location ID | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return projects whose last modification date is before date | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return projects whose last modification date is on or after date | |
| 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) | |
| projectManagerIds | No | Filters by id of managers for matching project | |
| projectTypeId | No | Format - int64. Return projects if it contains the specified project type | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn, Name, TargetCompletionDate. | |
| startsBefore | No | Format - date-time (as date-time in RFC3339). Return projects that start before date | |
| startsOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return projects that start on or after date | |
| status | No | Returns projects which have one of the provided statuses. "None" could be passed as one of the values to include projects without a status in the resulting collection. | |
| targetCompletionDateBefore | No | Format - date-time (as date-time in RFC3339). Return projects whose target completion date is before date | |
| targetCompletionDateOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return projects whose target completion date is on or after date | |
| technicianId | No | Format - int64. Return project if technician is assigned to any appointments on any job in the project | |
| tenant | Yes | Format - int64. Tenant ID |