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
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 |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"active": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "What kind of items should be returned (only active items will be returned by default)\nValues: [True, Any, False]"
},
"costTypeIds": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Allows filtering by Cost Type Ids"
},
"createdBefore": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "date-time",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)"
},
"createdOnOrAfter": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "date-time",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)"
},
"externalDataApplicationGuid": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "uuid",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - guid. Items that are created with a specific guid, could be fetched/updated/removed\nonly when the same application guid is provided"
},
"externalDataKey": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Allows filtering by external data key"
},
"externalDataValues": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Allows filtering by external data values"
},
"ids": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Perform lookup by multiple IDs (maximum 50)"
},
"includeTotal": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "boolean"
}
]
},
{
"type": "null"
}
],
"description": "Whether total count should be returned"
},
"isOtherDirectCost": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "boolean"
}
]
},
{
"type": "null"
}
],
"description": "Allows filtering by Is Other Direct Cost"
},
"modifiedBefore": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "date-time",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)"
},
"modifiedOnOrAfter": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "date-time",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)"
},
"page": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "integer"
}
]
},
{
"type": "null"
}
],
"description": "Format - int32. The logical number of page to return, starting from 1"
},
"pageSize": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "integer"
}
]
},
{
"type": "null"
}
],
"description": "Format - int32. How many records to return (50 by default)"
},
"sort": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Applies sorting by the specified field:\n\"?sort=+FieldName\" for ascending order,\n\"?sort=-FieldName\" for descending order.\n\nAvailable fields are: Id, Code, DisplayName, CreatedOn, ModifiedOn, Price, MemberPrice, AddOnPrice, AddOnMemberPrice, MaterialsCost, PrimaryVendor, Cost, Manufacturer, Priority."
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}