installed_equipment_get_list
Retrieve a list of installed equipment from ServiceTitan by filtering data based on location, IDs, creation/modification dates, page size, sorting, and active status. Supports pagination and total count inclusion.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
active | No | What kind of items should be returned | |
createdBefore | No | Return items created before certain date/time (in UTC) | |
createdOnOrAfter | No | 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 | |
locationIds | No | Location IDs | |
modifiedBefore | No | Return items modified before certain date/time (in UTC) | |
modifiedOnOrAfter | No | Return items modified on or after certain date/time (in UTC) | |
page | No | The logical number of page to return, starting from 1 | |
pageSize | No | How many records to return (50 by default) | |
sort | No | Applies sorting by the specified field | |
tenant | Yes | Tenant ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"active": {
"description": "What kind of items should be returned",
"type": [
"string",
"null"
]
},
"createdBefore": {
"description": "Return items created before certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"createdOnOrAfter": {
"description": "Return items created on or after certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"ids": {
"description": "Perform lookup by multiple IDs (maximum 50)",
"type": [
"string",
"null"
]
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": [
"boolean",
"null"
]
},
"locationIds": {
"description": "Location IDs",
"type": [
"string",
"null"
]
},
"modifiedBefore": {
"description": "Return items modified before certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"modifiedOnOrAfter": {
"description": "Return items modified on or after certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The logical number of page to return, starting from 1"
},
"pageSize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "How many records to return (50 by default)"
},
"sort": {
"description": "Applies sorting by the specified field",
"type": [
"string",
"null"
]
},
"tenant": {
"description": "Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}