contacts_get_list
Retrieve and filter contact lists from ServiceTitan by criteria like name, creation/modification dates, and archive status. Supports sorting, pagination, and total count inclusion for efficient data management.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
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) | |
includeTotal | No | Whether total count should be returned | |
isArchived | No | Filters by contact archive status | |
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) | |
name | No | Filters by contact 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) | |
referenceId | No | Filters by external reference ID | |
sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn. | |
tenant | Yes | Format - int64. Tenant ID | |
title | No | Filters by contact title |