customers_getlist
Retrieve and filter customer records from ServiceTitan using tenant ID, pagination, sorting, date ranges, and specific criteria like name, address, or status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | Returns customer records by active status (only active items will be returned by default). Values: [True, Any, False] | |
| city | No | Returns customer records by city. | |
| country | No | Returns customer records by country. | |
| createdBefore | No | Format - date-time (as date-time in RFC3339). Returns customer records created before the requested date (in UTC) | |
| createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Returns customer records created on or after the requested date (in UTC) | |
| excludeAccountingChangesFromModifiedDateRange | No | Excludes accounting changes such as balance adjustments from the modified date range. | |
| externalDataApplicationGuid | No | Format - guid. Returns customer records with external data for a particular GUID | |
| externalDataKey | No | ||
| externalDataValues | No | ||
| ids | No | Returns specific customer records by customer ID. | |
| includeTotal | No | Whether total count should be returned | |
| latitude | No | Format - double. Returns customer records by latitude. | |
| longitude | No | Format - double. Returns customer records by longitude. | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Returns customer records modified before the requested date (in UTC) | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Returns customer records modified after the requested date (in UTC) | |
| name | No | Returns customer records by name. | |
| 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) | |
| phone | No | Returns customer records by phone number of contacts. | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn. | |
| state | No | Returns customer records by state. | |
| street | No | Returns customer records by street. | |
| tenant | Yes | Format - int64. Tenant ID | |
| unit | No | Returns customer records by unit. | |
| zip | No | Returns customer records by zip. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"active": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns customer records by active status (only active items will be returned by default).\nValues: [True, Any, False]"
},
"city": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns customer records by city."
},
"country": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns customer records by country."
},
"createdBefore": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "date-time",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Returns customer records created before the requested date (in UTC)"
},
"createdOnOrAfter": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "date-time",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Returns customer records created on or after the requested date (in UTC)"
},
"excludeAccountingChangesFromModifiedDateRange": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "boolean"
}
]
},
{
"type": "null"
}
],
"description": "Excludes accounting changes such as balance adjustments from the modified date range."
},
"externalDataApplicationGuid": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "uuid",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - guid. Returns customer records with external data for a particular GUID"
},
"externalDataKey": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
]
},
"externalDataValues": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
]
},
"ids": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns specific customer records by customer ID."
},
"includeTotal": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "boolean"
}
]
},
{
"type": "null"
}
],
"description": "Whether total count should be returned"
},
"latitude": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "number"
}
]
},
{
"type": "null"
}
],
"description": "Format - double. Returns customer records by latitude."
},
"longitude": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "number"
}
]
},
{
"type": "null"
}
],
"description": "Format - double. Returns customer records by longitude."
},
"modifiedBefore": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "date-time",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Returns customer records modified before the requested date (in UTC)"
},
"modifiedOnOrAfter": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"format": "date-time",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Returns customer records modified after the requested date (in UTC)"
},
"name": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns customer records by name."
},
"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)"
},
"phone": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns customer records by phone number of contacts."
},
"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, ModifiedOn, CreatedOn."
},
"state": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns customer records by state."
},
"street": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns customer records by street."
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
},
"unit": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns customer records by unit."
},
"zip": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Returns customer records by zip."
}
},
"required": [
"tenant"
],
"type": "object"
}