transfers_getlist
Retrieve and filter transfer data within ServiceTitan by tenant ID, statuses, locations, dates, custom fields, or external data keys. Supports sorting and pagination for efficient data management.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batchId | No | Format - int64. Batch filter | |
| 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) | |
| customFields.Fields | No | Collection of custom field pairs (name, value) to filter by | |
| customFields.Operator | No | Can be "Or" or "And"\nValues: [And, Or] | |
| dateBefore | No | Format - date-time (as date-time in RFC3339). Return transfers with date before certain date/time | |
| dateOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return transfers with date on or after certain date/time | |
| externalDataApplicationGuid | No | Format - guid. If this guid is provided, external data corresponding to this application guid will be returned. | |
| externalDataKey | No | Performs lookup by external data key, 'externalDataValues' must also be provided. | |
| externalDataValues | No | Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided. | |
| fromLocationIds | No | Filter by a collection of From field locations | |
| ids | No | Perform lookup by multiple IDs (maximum 50) | |
| includeTotal | No | Whether total count should be returned | |
| 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) | |
| number | No | Number filter | |
| 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) | |
| referenceNumber | No | Reference number filter | |
| sort | No | 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. | |
| statuses | No | Filter by a collection of statuses | |
| syncStatuses | No | Filter by a collection of sync statuses | |
| tenant | Yes | Format - int64. Tenant ID | |
| toLocationIds | No | Filter by a collection of To field locations | |
| transferTypeIds | No | Filter by a collection of transfer types |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"batchId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64. Batch filter"
},
"createdBefore": {
"description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"createdOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"customFields.Fields": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Collection of custom field pairs (name, value) to filter by"
},
"customFields.Operator": {
"description": "Can be \"Or\" or \"And\"\\nValues: [And, Or]",
"type": [
"string",
"null"
]
},
"dateBefore": {
"description": "Format - date-time (as date-time in RFC3339). Return transfers with date before certain date/time",
"type": [
"string",
"null"
]
},
"dateOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return transfers with date on or after certain date/time",
"type": [
"string",
"null"
]
},
"externalDataApplicationGuid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - guid. If this guid is provided, external data corresponding to\nthis application guid will be returned."
},
"externalDataKey": {
"description": "Performs lookup by external data key, 'externalDataValues' must also be provided.",
"type": [
"string",
"null"
]
},
"externalDataValues": {
"description": "Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided.",
"type": [
"string",
"null"
]
},
"fromLocationIds": {
"description": "Filter by a collection of From field locations",
"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"
]
},
"modifiedBefore": {
"description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"modifiedOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"number": {
"description": "Number filter",
"type": [
"string",
"null"
]
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. The logical number of page to return, starting from 1"
},
"pageSize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. How many records to return (50 by default)"
},
"referenceNumber": {
"description": "Reference number filter",
"type": [
"string",
"null"
]
},
"sort": {
"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.",
"type": [
"string",
"null"
]
},
"statuses": {
"description": "Filter by a collection of statuses",
"type": [
"string",
"null"
]
},
"syncStatuses": {
"description": "Filter by a collection of sync statuses",
"type": [
"string",
"null"
]
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
},
"toLocationIds": {
"description": "Filter by a collection of To field locations",
"type": [
"string",
"null"
]
},
"transferTypeIds": {
"description": "Filter by a collection of transfer types",
"type": [
"string",
"null"
]
}
},
"required": [
"tenant"
],
"type": "object"
}