attributed_leads_get
Retrieve attributed leads for a specific tenant within a defined time frame, filtered by lead type and pagination settings. Use this tool to access detailed lead data via the ServiceTitan MCP Server.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
fromUtc | Yes | Format - date-time (as date-time in RFC3339). Gets or sets the start date and time in UTC for the filtering period. | |
includeTotal | No | Whether total count should be returned | |
leadType | No | Gets or sets the type of lead for filtering purposes. Possible values are: LeadType.Call, LeadType.WebBooking, LeadType.WebLeadForm, LeadType.ManualJob. If null, data for all lead types is returned. | |
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) | |
tenant | Yes | Format - int64. Tenant ID | |
toUtc | Yes | Format - date-time (as date-time in RFC3339). Gets or sets the end date and time in UTC for the filtering period. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"fromUtc": {
"description": "Format - date-time (as date-time in RFC3339). Gets or sets the start date and time in UTC for the filtering period.",
"format": "date-time",
"type": "string"
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": [
"boolean",
"null"
]
},
"leadType": {
"anyOf": [
{
"enum": [
"Call",
"WebBooking",
"WebLeadForm",
"ManualJob"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Gets or sets the type of lead for filtering purposes. Possible values are: LeadType.Call, LeadType.WebBooking, LeadType.WebLeadForm, LeadType.ManualJob. If null, data for all lead types is returned."
},
"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)"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
},
"toUtc": {
"description": "Format - date-time (as date-time in RFC3339). Gets or sets the end date and time in UTC for the filtering period.",
"format": "date-time",
"type": "string"
}
},
"required": [
"tenant",
"fromUtc",
"toUtc"
],
"type": "object"
}