customers_getlist
Retrieve customer records from the ServiceTitan API based on filters like location, creation/modification dates, active status, and more. Supports pagination and sorting for efficient data access.
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. |