materials_get_list
Retrieve and filter material data in ServiceTitan by tenant ID, cost type, date ranges, and sorting options for efficient inventory management and reporting.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | What kind of items should be returned (only active items will be returned by default) Values: [True, Any, False] | |
| costTypeIds | No | Allows filtering by Cost Type Ids | |
| 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) | |
| externalDataApplicationGuid | No | Format - guid. Items that are created with a specific guid, could be fetched/updated/removed only when the same application guid is provided | |
| externalDataKey | No | Allows filtering by external data key | |
| externalDataValues | No | Allows filtering by external data values | |
| ids | No | Perform lookup by multiple IDs (maximum 50) | |
| includeTotal | No | Whether total count should be returned | |
| isOtherDirectCost | No | Allows filtering by Is Other Direct Cost | |
| 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) | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, Code, DisplayName, CreatedOn, ModifiedOn, Price, MemberPrice, AddOnPrice, AddOnMemberPrice, MaterialsCost, PrimaryVendor, Cost, Manufacturer, Priority. | |
| tenant | Yes | Format - int64. Tenant ID |