calls_get_calls
Retrieve call data from ServiceTitan API by filtering parameters like tenant ID, call duration, phone number, agent details, and date ranges. Simplify call analytics and reporting.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| activeOnly | No | ||
| agentExternalId | No | Format - int64. Agent external ID (number) | |
| agentId | No | Format - int64. Agent ID (number) | |
| agentIsExternal | No | Is agent external flag (boolean) | |
| agentName | No | Agent name (string) | |
| campaignId | No | Format - int64. Campaign ID | |
| createdAfter | No | Format - date-time (as date-time in RFC3339). | |
| createdBefore | No | Format - date-time (as date-time in RFC3339). | |
| createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Created on or after a certain date/time (as date-time in RFC3339), inclusive | |
| ids | No | ||
| minDuration | No | Format - int32. Minimum call duration (number) | |
| modifiedAfter | No | Format - date-time (as date-time in RFC3339). Modified after a certain date/time (as date-time in RFC3339), not inclusive | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Modified before a certain date/time (as date-time in RFC3339), not inclusive | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Modified on or after a certain date/time (as date-time in RFC3339), inclusive | |
| orderBy | No | Sorting (string with possible values Id (default), createdOn, or modifiedOn) | |
| orderByDirection | No | Sorting direction (string with possible values asc (default) or desc) | |
| page | No | Format - int32. | |
| pageSize | No | Format - int32. | |
| phoneNumberCalled | No | The phone number that was called (string) | |
| tenant | Yes | Format - int64. Tenant ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"activeOnly": {
"type": "boolean"
},
"agentExternalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64. Agent external ID (number)"
},
"agentId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64. Agent ID (number)"
},
"agentIsExternal": {
"description": "Is agent external flag (boolean)",
"type": [
"boolean",
"null"
]
},
"agentName": {
"description": "Agent name (string)",
"type": "string"
},
"campaignId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64. Campaign ID"
},
"createdAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339)."
},
"createdBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339)."
},
"createdOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Created on or after a certain date/time (as date-time in RFC3339), inclusive"
},
"ids": {
"items": {
"type": "integer"
},
"type": "array"
},
"minDuration": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. Minimum call duration (number)"
},
"modifiedAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Modified after a certain date/time (as date-time in RFC3339), not inclusive"
},
"modifiedBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Modified before a certain date/time (as date-time in RFC3339), not inclusive"
},
"modifiedOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Modified on or after a certain date/time (as date-time in RFC3339), inclusive"
},
"orderBy": {
"description": "Sorting (string with possible values Id (default), createdOn, or modifiedOn)",
"type": "string"
},
"orderByDirection": {
"description": "Sorting direction (string with possible values asc (default) or desc)",
"type": "string"
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32."
},
"pageSize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32."
},
"phoneNumberCalled": {
"description": "The phone number that was called (string)",
"type": "string"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}