ServiceTitan MCP Server

attributed_leads_get

Retrieve filtered lead data from ServiceTitan API by specifying criteria such as lead type, date range, tenant ID, and pagination for efficient data analysis.

Input Schema

NameRequiredDescriptionDefault
fromUtcYesFormat - date-time (as date-time in RFC3339). Gets or sets the start date and time in UTC for the filtering period.
includeTotalNoWhether total count should be returned
leadTypeNoGets 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.
pageNoFormat - int32. The logical number of page to return, starting from 1
pageSizeNoFormat - int32. How many records to return (50 by default)
tenantYesFormat - int64. Tenant ID
toUtcYesFormat - 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" }

You must be authenticated.

Other Tools from ServiceTitan MCP Server

Related Tools

ID: mrnu4dtu2r