ServiceTitan MCP
This server acts as a comprehensive Model Context Protocol (MCP) interface for the ServiceTitan API, providing 483 tools across 15 domains plus 10 intelligence tools for managing field service business operations and gaining deep operational insights.
Core Domains:
CRM – Create, update, list, and delete customers, contacts, locations, leads, bookings, notes, tags, and contact relationships
Dispatch (79 tools) – Manage jobs, appointments, and job types
Accounting (49 tools) – Handle invoices, payments, GL accounts, journal entries, AP credits, tax zones, and payment terms
Export (49 tools) – Bulk export of invoices, customers, and jobs
Inventory (37 tools) – Manage purchase orders, vendors, and warehouses
Marketing (35 tools) – Work with campaigns, calls, and reviews
Pricebook (31 tools) – List services, materials, and equipment
Payroll (27 tools) – Access payrolls, timesheets, and gross pay items
Settings (23 tools) – Retrieve business units, tag types, and user roles
People (22 tools) – Manage technicians, employees, and trucks
Estimates (22 tools) – List, get, and manage estimate items
Memberships (21 tools) – Handle memberships, types, and recurring services
Scheduling (17 tools) – Manage teams, zones, and capacity
Reporting (5 tools) – List report categories and execute reports
Intelligence Tools (10):
Dashboard-matched revenue summaries, same-day operational snapshots, technician scorecards, membership health reports, estimate pipeline metrics, campaign performance, CSR performance, labor cost analysis, invoice tracking, and reference data lookups
Safety & Configuration:
Read-only mode by default — write/delete tools blocked unless explicitly enabled
Confirmation workflow — delete operations require
confirm: trueAudit logging — all write/delete actions logged with sanitized parameters
Name-based filtering — human-readable names (e.g.,
businessUnitName) auto-resolved to IDsDomain filtering — expose only specific tool groups via
ST_DOMAINSSystem health check (
st_health_check) — validate API authentication and tenant accessRemote deployment — supports Streamable HTTP and SSE transports; integrates with Claude Desktop and other MCP-compatible hosts
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@ServiceTitan MCP Show me a summary of revenue intelligence for this month"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
ServiceTitan MCP Server
A ServiceTitan MCP package for independently configured companies. V3 uses pinned official API contracts, readonly discovery, configurable report bindings, and explicit data-completeness checks.
Built by Rowvyn. Version 3.0.2 provides stable read-only support under the readonly-v1 policy: one separately configured runtime per company, followed by that company's readiness and report-definition validation. Read the v3 migration guide before upgrading.
Start with a focused profile
Choose the workflow your agent needs before connecting. These counts include the three system tools for health, readiness, and stored-result retrieval:
Workflow |
| Read tools |
Customer and location work |
| 33 |
Revenue and operational analytics |
| 34 |
Dispatch, scheduling, people, and settings |
| 75 |
Full API coverage |
| 264 |
Use Node 22 or 24. The following complete stdio configurations install the versioned npm package. Replace all four credential placeholders with credentials for your company. They explicitly select production for a live company; use integration with matching integration credentials when validating there. Set ST_TIMEZONE to your company's IANA timezone. Each server process serves one independently configured company.
For analytics:
{
"mcpServers": {
"servicetitan": {
"command": "npx",
"args": ["-y", "@rowvyn/servicetitan-mcp@3.0.2"],
"env": {
"ST_CLIENT_ID": "your-client-id",
"ST_CLIENT_SECRET": "your-client-secret",
"ST_APP_KEY": "your-app-key",
"ST_TENANT_ID": "your-tenant-id",
"ST_ENVIRONMENT": "production",
"ST_TIMEZONE": "America/New_York",
"ST_READONLY": "true",
"ST_TOOL_PROFILE": "analytics"
}
}
}
}For CRM:
{
"mcpServers": {
"servicetitan": {
"command": "npx",
"args": ["-y", "@rowvyn/servicetitan-mcp@3.0.2"],
"env": {
"ST_CLIENT_ID": "your-client-id",
"ST_CLIENT_SECRET": "your-client-secret",
"ST_APP_KEY": "your-app-key",
"ST_TENANT_ID": "your-tenant-id",
"ST_ENVIRONMENT": "production",
"ST_TIMEZONE": "America/New_York",
"ST_READONLY": "true",
"ST_TOOL_PROFILE": "crm"
}
}
}
}For dispatch, change only ST_TOOL_PROFILE in either configuration to dispatch. Choose full for all 264 read tools. The profile, ST_DOMAINS, and ST_TOOLS filters intersect; a tool must satisfy each configured filter. For example, adding ST_TOOLS=crm_customers_get to the CRM configuration exposes that customer lookup plus the three system tools. Profiles select tools and do not grant ServiceTitan scopes. Start with st_health_check for authentication/read access and st_readiness_check for module and report compatibility.
The tool catalog explains selection among list, get, and export operations. Four export feeds retain equivalent generic and domain-specific names for compatibility; use one available name per feed. Focused profiles naturally exclude the generic export domain. Every existing v3.0.0 name remains available under its original configuration in v3.0.2.
Related MCP server: servicetitan-mcp
Run from source
Use Node 22 or 24. Install the locked dependencies, build, and put credentials in an ignored .env copied from .env.example:
npm ci
npm run build
node --env-file=.env build/readiness-cli.js
node --env-file=.env build/index.jsRequired values are ST_CLIENT_ID, ST_CLIENT_SECRET, ST_APP_KEY, and ST_TENANT_ID. Select ST_ENVIRONMENT=production for a live company; the default is integration. Set the company's IANA timezone explicitly, such as America/New_York.
Keep the credential file outside source control, restrict it to the account running the server, and never paste credentials or access tokens into logs, issues, pull requests, benchmark output, or MCP prompts. Integration and production credentials are environment-specific; keep each set with its matching auth/API environment. Grant only the ServiceTitan scopes needed by the selected tools, and replace credentials through the ServiceTitan Developer Portal if exposure is suspected. ServiceTitan recommends developing in integration before production and requires the client secret for OAuth plus the app key on resource calls. See Make Your First API Call, ServiceTitan's customer credential guidance, and the API Terms.
Configure an MCP host to run node with --env-file=/absolute/path/.env and /absolute/path/build/index.js. Stdio reserves stdout for MCP protocol traffic. Logs and mutation audits go to stderr.
The package also provides servicetitan-mcp, servicetitan-mcp-http, servicetitan-mcp-sse, and servicetitan-mcp-check command entrypoints.
Choose the tool surface
The generated catalog lists 458 tools: 261 ServiceTitan-facing read tools backed by pinned API contracts, three built-in system tools, and 194 experimental mutations. The 264-tool readonly discovery surface is eligible for stable support subject to each company's scopes/modules and readiness/report validation. Live verification sampled representative reads rather than every tool. Discovery is filtered by configuration:
Setting | Behavior |
| Default; mutating tools are absent from discovery and cannot execute. |
| Default; setting |
| All supported domains, still subject to readonly and other filters. |
| CRM tools. |
| Dispatch, scheduling, people, settings. |
| Intelligence, reporting, settings. |
| Intersects the profile with selected domains. |
| Exact tool-name allowlist; unknown or unavailable selections fail startup. |
System health, readiness, and result-retrieval tools remain accessible through the same authorization checks. Profiles do not grant upstream ServiceTitan scopes. Undocumented operations removed in v3 remain unavailable even in the full profile.
Writes are outside the stable v3 support commitment. To expose these experimental adapters, set both ST_READONLY=false and ST_EXPERIMENTAL_WRITES=true. ST_CONFIRM_WRITES=true then requires _confirmed:true for writes; deletes separately require confirm:true. These are safeguards against accidental changes, not independent human authorization. Uncertain write outcomes explicitly instruct checking ServiceTitan before retrying; the client does not blindly retry timeouts or 5xx writes.
Readiness and report compatibility
st_readiness_check and the check CLI validate authentication, representative enabled-module reads, and configured report definitions. They return field/parameter metadata and definition fingerprints, not customer records. Missing scopes, missing reports, and incompatible fields are actionable failures. Representative read access does not certify every operation, write scope, or KPI amount.
Bind a company's reports with JSON in ST_REPORT_BINDINGS:
ST_REPORT_BINDINGS={"166":{"category":"accounting","reportId":900166}}The keys are the logical report IDs used by analytics; the values select this company's category and actual report ID. Required fields are validated by name and reordered before calculations. Default Report 166 provides hours but no gross pay; labor costs and hourly rates are null with explicit availability metadata. A compatible configured report that includes GrossPay can supply those metrics.
Analytics follows pagination and rejects missing/inconsistent required data. Optional feed failures remain in _warnings. Review warnings and completeness metadata before treating an answer as a complete business result. Report execution is scheduled per report and API client, with a 65-second interval between starts; expensive multi-page reports can take minutes. Set an appropriate host request timeout and use cancellation when abandoning a query. Separate server processes still share ServiceTitan's upstream report limit.
Metrics have explicit meanings. Period revenue minus payments is no longer labeled outstanding A/R; membership period counts are not labeled cohort retention; independent booked-call and booking counts are not treated as one conversion cohort. Representative readonly behavior has been exercised with one production company. V3 does not certify dashboard parity or independent-company compatibility; Scheduling Pro access returned 403 in that validation and remains unverified.
Structured and bounded results
Successful tools provide the same JSON in structuredContent and the text content. Arrays/scalars are wrapped as {data:...}. Semantic fields, warnings, continuations, names, and precision are preserved. Timestamps may be rendered in the configured timezone without changing the instant; keys explicitly labeled UTC remain UTC.
ST_MAX_RESPONSE_CHARS defaults to 100,000 and covers the final serialized tool envelope, including both representations. Large results can return an opaque handle for st_result_read: start at offset 0, concatenate each text chunk in nextOffset order, and parse the assembled JSON. Stored results belong to one server/session, expire after five minutes, and are bounded to four entries and 4 MB total. Restarting or closing the session removes them. A full store may evict older entries.
Stored chunks and normal tool responses can contain customer content. Protect the MCP channel and any client-side transcripts or exports, retrieve only what the workflow needs, and delete locally retained validation output when it is no longer needed. Do not publish raw live responses as test evidence.
If the result or retrieval metadata cannot fit configured storage/budget limits, the tool returns an explicit delivery error with source-pagination guidance. It never passes a cut JSON preview off as complete data. The minimum accepted response budget is 256 characters; useful result handles require a larger budget such as 1,024 or more. A delivery failure after a successful mutation is recorded separately in its audit and does not imply that the mutation should be retried.
Remote transports
node --env-file=.env build/streamable-http.jsSet a strong ST_MCP_API_KEY; send it in x-api-key or a Bearer Authorization header. The server binds to loopback by default. Set ST_MCP_HOST=0.0.0.0 only when needed, such as a container behind an HTTPS proxy. Streamable HTTP uses /mcp; /health is an unauthenticated liveness endpoint.
Requests with a browser Origin require an exact ST_CORS_ORIGIN match. Without a configured origin, native clients without Origin are allowed and browser origins are rejected. Wildcards are not accepted.
ST_ALLOWED_CALLERS uses authenticated SDK identity. Request _meta and arbitrary forwarded identity headers are ignored. With the built-in shared API key, the authenticated principal is ST_MCP_CLIENT_ID (default api-key); this is one credential identity, not per-user identity. Embedders needing user identities must provide validated SDK authInfo through an authenticated transport.
HTTP sessions are bounded by ST_MAX_SESSIONS (32 default). Registry tool concurrency defaults to 16; ordinary API requests have a bounded queue and concurrency. Idle sessions are reaped after 30 minutes; active requests/streams are tracked. Session state and result handles are process-local, so multi-instance deployments need sticky routing. Legacy SSE is a single-client compatibility entrypoint: a new SSE connection replaces the prior one. Prefer Streamable HTTP.
Mutation audit events are emitted even when diagnostic log level is error; contact values, credentials, and free text are redacted. Configure durable stderr collection if durable audit retention is required.
Embed one company or separate company runtimes
The import entrypoint has no transport startup side effects:
import { createMcpServer, loadConfig } from '@rowvyn/servicetitan-mcp';
const { server } = await createMcpServer(loadConfig(companyEnvironment));
await server.connect(yourTransport);Create a separate client/runtime for each company. Caches and report queues use client identity; request timezone/budget/cancellation are scoped to the call. Sharing a ServiceTitan client across companies is unsupported. The package includes TypeScript declarations.
Development and release gates
Run these commands from a repository checkout; the npm package contains the runtime and maintained documentation.
npm run contracts:check
npm run typecheck
npm run lint
npm run test:coverage
npm run test:wire
npm run test:packaging
npm run docs:tools
npm run discovery:check
npm pack --dry-run
npm run release:checkThe contract generator uses the pinned official September 4, 2026 snapshot; upstream changes require a reviewed manifest regeneration. Contract tests cover resolved paths and request payloads. The normal suite includes auth/retry, paging, cancellation, DST, schema/metric, configuration isolation, transport and response-budget regressions. Built-process tests use dummy credentials and do not execute ServiceTitan business reads or writes.
Packaging tests use synthetic credential files to verify npm and Docker exclusions. The Docker check captures the installed CLI's context against a local mock engine, requires no running daemon, and skips explicitly when the CLI is unavailable. It never sends the repository or live credentials to a builder.
CI tests Node 22 and 24. The required aggregate ci check passes only when both runtime jobs succeed. The readonly-v1 release policy requires maintenance, contracts, analytics, interface, runtime-matrix, package-smoke, bounded readonly production, and latency/load gates plus a current source fingerprint. Unavailable integration-environment and independent-company gates are recorded as scoped out, never as passed. Releases keep npm Trusted Publishing and publish prereleases to next, stable versions to latest.
See the validation summary for coverage and remaining acceptance gates, and the benchmark results and reproduction instructions for latency, load, caching, and memory measurements.
Official sources: ServiceTitan API catalog, Reporting API, and API rate limits.
Available Tools
264 toolsaccounting_ap_credits_listARead-onlyIdempotent
List one requested page of vendor AP credits, filterable by credit IDs and created or modified timestamps. Use this for credits on vendor accounts; use accounting_ap_payments_list for AP disbursements and accounting_payments_list for customer receipts.
Inputs: ids, page, sort, pageSize, +5 more. Returns: object
accounting_ap_payments_listARead-onlyIdempotent
List one requested page of vendor AP payments, filterable by payment IDs and created or modified timestamps. Use this for accounts-payable disbursements; use accounting_ap_credits_list for vendor credits and accounting_payments_list for customer receipts.
Inputs: ids, page, sort, pageSize, +5 more. Returns: object
accounting_gl_accounts_getARead-onlyIdempotent
Retrieve a GL account by its ServiceTitan ID. Returns the single upstream record without pagination; use accounting_gl_accounts_list to search when the ID is unknown.
Inputs: accountId (required). Returns: object
accounting_gl_accounts_listARead-onlyIdempotent
List one requested page of general-ledger accounts, with filters for IDs, names, numbers, types, subtypes, source, description, and Intacct flags. Use accounting_gl_accounts_get for one known account and accounting_gl_account_types_list to resolve account-type metadata.
Inputs: ids, page, sort, names, +14 more. Returns: object
accounting_gl_account_types_listARead-onlyIdempotent
List one requested page of GL account-type definitions, filterable by type IDs, names, and active state. Use this catalog to resolve types for GL accounts; use accounting_gl_accounts_list for the actual ledger accounts.
Inputs: ids, page, sort, names, +7 more. Returns: object
accounting_invoices_custom_field_types_listARead-onlyIdempotent
List one requested page of invoice custom-field definitions, with paging and total-count controls. Use this to resolve the metadata for invoice custom fields; use accounting_invoices_list to retrieve invoice records and their values.
Inputs: page, sort, pageSize, includeTotal, +4 more. Returns: object
accounting_invoices_listARead-onlyIdempotent
List one requested page of customer invoice headers using customer, job, business-unit, invoice, date, amount, balance, review, and assignment filters. Use this for filtered invoice search; use estimates or invoice-item tools when the required grain is an estimate or individual line item.
Inputs: ids, page, sort, jobId, +28 more. Returns: object
accounting_journal_entries_get_detailsARead-onlyIdempotent
Retrieve journal-entry detail rows for the requested journal-entry IDs. Use this for line-level account and amount detail; use accounting_journal_entries_get_summary for header-level totals.
Inputs: id (required), page, pageSize, includeTotal. Returns: object
accounting_journal_entries_get_summaryARead-onlyIdempotent
Retrieve journal-entry summary rows for the requested journal-entry IDs. Use this for header-level accounting totals; use accounting_journal_entries_get_details for the corresponding line-level detail rows.
Inputs: id (required), page, pageSize, includeTotal. Returns: object
accounting_journal_entries_listARead-onlyIdempotent
List one requested page of journal-entry headers using IDs, numbers, sync status, posted dates, and created or modified timestamps. Use this to discover entry IDs, then choose accounting_journal_entries_get_summary for summary rows or accounting_journal_entries_get_details for line-level rows.
Inputs: ids, name, page, sort, +26 more. Returns: object
accounting_payments_custom_field_types_listARead-onlyIdempotent
List one requested page of payment custom-field definitions, with paging and total-count controls. Use this to resolve payment field metadata; use accounting_payments_list for customer payment transactions and their field values.
Inputs: page, sort, pageSize, includeTotal, +4 more. Returns: object
accounting_payments_listARead-onlyIdempotent
List one requested page of customer payment transactions using payment or applied-invoice identifiers, customer, business-unit, batch, status, date, and total-amount filters. Use accounting_payment_types_list for payment-method definitions; use accounting_ap_payments_list for vendor disbursements.
Inputs: ids, page, sort, batchId, +19 more. Returns: object
accounting_payment_terms_getARead-onlyIdempotent
Retrieve a payment term by its ServiceTitan ID. Returns the single upstream record without pagination; use accounting_payment_terms_list to search when the ID is unknown.
Inputs: paymentTermId (required). Returns: object
accounting_payment_terms_listARead-onlyIdempotent
List one requested page of invoice payment-term definitions, filterable by IDs and created or modified timestamps. Use accounting_payment_terms_get for one known term; use accounting_invoices_list for invoice transactions.
Inputs: ids, page, sort, pageSize, +5 more. Returns: object
accounting_payment_types_getARead-onlyIdempotent
Retrieve a payment type by its ServiceTitan ID. Returns the single upstream record without pagination; use accounting_payment_types_list to search when the ID is unknown.
Inputs: id (required). Returns: object
accounting_payment_types_listARead-onlyIdempotent
List one requested page of customer payment-type definitions, filterable by IDs, active state, and creation timestamps. Use this catalog to interpret or select payment methods; use accounting_payments_list for actual customer payment transactions.
Inputs: ids, page, active, pageSize, +3 more. Returns: object
accounting_tax_zones_listARead-onlyIdempotent
List one requested page of tax-zone definitions, filterable by IDs, active state, and created or modified timestamps. Use this catalog to resolve tax treatment identifiers; it does not return invoice transactions or calculated tax totals.
Inputs: ids, page, sort, active, +6 more. Returns: object
crm_booking_provider_tags_getARead-onlyIdempotent
Retrieve one booking-provider tag record by ID, including its name and description. Use crm_booking_provider_tags_list to search by name, multiple IDs, or change dates.
Inputs: id (required). Returns: object
crm_booking_provider_tags_listARead-onlyIdempotent
Search booking-provider tag definitions by name, IDs, or created and modified ranges. Returns one page; use crm_booking_provider_tags_get when the tag ID is already known.
Inputs: ids, name, page, sort, +6 more. Returns: object
crm_bookings_contacts_listARead-onlyIdempotent
List one page of contacts attached to a tenant booking. Supply the booking ID; use page and pageSize to continue through results.
Inputs: id (required), page, pageSize, includeTotal. Returns: object
crm_bookings_getARead-onlyIdempotent
Retrieve one tenant booking record by booking ID. Use crm_bookings_list to search when the ID is unknown, or the provider-scoped get when the booking provider must be part of the route.
Inputs: id (required). Returns: object
crm_bookings_listARead-onlyIdempotent
Search tenant bookings by IDs, external ID, or created and modified ranges. Returns one page; use crm_bookings_get for a known booking ID.
Inputs: ids, page, sort, pageSize, +6 more. Returns: object
crm_bookings_provider_contacts_listARead-onlyIdempotent
List one page of contacts for a booking within a specified booking provider. Requires both provider and booking IDs.
Inputs: id (required), bookingProvider (required), page, pageSize, +1 more. Returns: object
crm_bookings_provider_getARead-onlyIdempotent
Retrieve one booking record from a specified booking provider using both provider and booking IDs. Use crm_bookings_get for the tenant-wide ID route, or the provider list when the booking ID is unknown.
Inputs: id (required), bookingProvider (required). Returns: object
crm_bookings_provider_listARead-onlyIdempotent
Search one booking provider's bookings by IDs, external ID, or created and modified ranges. Returns one page and requires the provider ID.
Inputs: bookingProvider (required), ids, page, sort, +7 more. Returns: object
crm_contact_methods_getARead-onlyIdempotent
Retrieve one contact-method record using its parent contact UUID and contact-method UUID. Use crm_contact_methods_list to search that contact's methods when the method ID is unknown.
Inputs: contactId (required), contactMethodId (required). Returns: object
crm_contact_methods_listARead-onlyIdempotent
Search one contact's phone, email, or other contact methods by reference, type, value, or date filters. Returns one page and requires contactId.
Inputs: contactId (required), page, sort, type, +8 more. Returns: object
crm_contact_relationships_listARead-onlyIdempotent
List one page of contact-to-entity relationship records for a known contact UUID, optionally filtered by related entity, type slug, type name, or creation time. Use crm_contacts_by_relationship_list for contacts associated with a known relationship ID.
Inputs: contactId (required), page, sort, pageSize, +6 more. Returns: object
crm_contacts_by_relationship_listARead-onlyIdempotent
Search contact records associated with a known relationship ID, with optional identity, archive, and date filters. Returns one page; use crm_contact_relationships_list to inspect the links owned by one known contact.
Inputs: relationshipId (required), name, page, sort, +9 more. Returns: object
crm_contacts_getARead-onlyIdempotent
Retrieve one CRM contact record by UUID, including its stored identity fields. Use crm_contacts_list to search by name, title, reference ID, archive status, or change dates.
Inputs: id (required). Returns: object
crm_contacts_listARead-onlyIdempotent
Search CRM contacts by name, title, reference ID, archive status, or date ranges. Returns one page; use crm_contacts_get for a known UUID.
Inputs: name, page, sort, title, +8 more. Returns: object
crm_customers_contacts_listARead-onlyIdempotent
List one page of contacts attached to a known customer. Use crm_customers_contacts_modified_list for cross-customer incremental contact queries.
Inputs: id (required), page, pageSize, includeTotal. Returns: object
crm_customers_contacts_modified_listARead-onlyIdempotent
Search contact records across specified customers using created or modified time ranges. Returns one page; use crm_customers_contacts_list for all contacts of one known customer.
Inputs: page, pageSize, customerIds, includeTotal, +4 more. Returns: object
crm_customers_custom_field_types_listARead-onlyIdempotent
List one page of custom-field type definitions available to customers, with created and modified date filters. This returns field metadata, not values for one customer.
Inputs: page, sort, pageSize, includeTotal, +4 more. Returns: object
crm_customers_getARead-onlyIdempotent
Retrieve one customer record by ID, including the customer data returned by ServiceTitan. Use crm_customers_list to search by name, address, phone, external data, activity, or date ranges.
Inputs: id (required). Returns: object
crm_customers_listARead-onlyIdempotent
Search customers by IDs, name, address, phone, coordinates, external data, activity, or created and modified ranges. Returns one page; use crm_customers_get for a known ID.
Inputs: ids, zip, city, name, +20 more. Returns: object
crm_customers_notes_listARead-onlyIdempotent
List one page of notes attached to a known customer, optionally filtered by created or modified timestamps. Requires the customer ID.
Inputs: id (required), page, pageSize, includeTotal, +4 more. Returns: object
crm_leads_getARead-onlyIdempotent
Retrieve one CRM lead record by ID, including its customer and lead details. Use crm_leads_list to search by customer, status, prospect state, location fields, or date ranges.
Inputs: id (required). Returns: object
crm_leads_listARead-onlyIdempotent
Search CRM leads by IDs, customer, status, prospect state, customer location, or created and modified ranges. Returns one page; use crm_leads_get for a known ID.
Inputs: ids, page, sort, status, +16 more. Returns: object
crm_leads_notes_listARead-onlyIdempotent
List one page of notes attached to a known lead, optionally filtered by created or modified timestamps. Requires the lead ID.
Inputs: id (required), page, pageSize, includeTotal, +4 more. Returns: object
crm_location_labor_types_listARead-onlyIdempotent
List one page of labor-type assignment records for specified location IDs, optionally filtered by active state or creation time. Use this to determine which labor types apply across known service locations.
Inputs: page, sort, active, pageSize, +4 more. Returns: object
crm_locations_contacts_listARead-onlyIdempotent
List one page of contacts attached to a known service location. Use crm_locations_contacts_modified_list for cross-location incremental contact queries.
Inputs: id (required), page, pageSize, includeTotal. Returns: object
crm_locations_contacts_modified_listARead-onlyIdempotent
Search contact records across specified locations using created or modified time ranges. Returns one page; use crm_locations_contacts_list for all contacts of one known location.
Inputs: page, pageSize, locationIds, includeTotal, +4 more. Returns: object
crm_locations_custom_field_types_listARead-onlyIdempotent
List one page of custom-field type definitions available to locations, with created and modified date filters. This returns field metadata, not values for one location.
Inputs: page, sort, pageSize, includeTotal, +4 more. Returns: object
crm_locations_getARead-onlyIdempotent
Retrieve one service-location record by ID, including its customer and address data. Use crm_locations_list to search by customer, address, external data, activity, or date ranges.
Inputs: id (required). Returns: object
crm_locations_listARead-onlyIdempotent
Search service locations by IDs, customer, name, address, coordinates, external data, activity, or date ranges. Returns one page; use crm_locations_get for a known ID.
Inputs: ids, zip, city, name, +19 more. Returns: object
crm_locations_notes_listARead-onlyIdempotent
List one page of notes attached to a known service location, optionally filtered by created or modified timestamps. Requires the location ID.
Inputs: id (required), page, pageSize, includeTotal, +4 more. Returns: object
dispatch_appointments_getARead-onlyIdempotent
Retrieve one appointment record by ID, including its dispatch and scheduling data. Use dispatch_appointments_list to search by job, customer, technician, status, start time, or other filters.
Inputs: id (required). Returns: object
dispatch_appointments_listARead-onlyIdempotent
Search appointments by IDs, job, project, customer, technician, status, start range, or created and modified ranges. Returns one page; use dispatch_appointments_get for a known ID.
Inputs: ids, page, sort, jobId, +14 more. Returns: object
dispatch_arrival_window_configuration_getARead-onlyIdempotent
Retrieve the tenant-wide arrival-window configuration as one unpaged response. It returns scheduling configuration rather than an individual window; use dispatch_arrival_windows_get or list for window definitions.
Inputs: no named parameters. Returns: object
dispatch_arrival_windows_getARead-onlyIdempotent
Retrieve one arrival-window definition by ID, including its time span and applicable business units. Use dispatch_arrival_windows_list to browse by active state or creation time.
Inputs: id (required). Returns: object
dispatch_arrival_windows_listARead-onlyIdempotent
List one page of arrival-window definitions, optionally filtered by active state or creation time. Each record supplies a configured window and applicable business units; use dispatch_arrival_windows_get for a known ID.
Inputs: page, active, pageSize, includeTotal, +2 more. Returns: object
dispatch_call_reasons_listARead-onlyIdempotent
List one page of dispatch call-reason catalog entries, filtered by active state or created and modified ranges. Use these IDs when a workflow requires a call reason.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
dispatch_forms_listARead-onlyIdempotent
Search dispatch form definitions by IDs, name, publication status, active state, conditional logic, triggers, and date ranges. Returns one page of form metadata; use dispatch_form_submissions_list for completed or pending submissions.
Inputs: ids, name, page, sort, +10 more. Returns: object
dispatch_form_submissions_listARead-onlyIdempotent
Search submitted form records by form, creator, status, owner expression, submitted range, or active state. Returns one page; use this for submission results rather than form definitions.
Inputs: page, sort, active, owners, +8 more. Returns: object
dispatch_images_getARead-onlyIdempotent
Request image response data for a ServiceTitan storage path. The upstream Pricebook image operation documents an HTTP 302 redirect; this wrapper returns the client-decoded response body through its standard JSON/text envelope, without exposing the redirect Location header. Supply the known path when targeting an image; use dispatch_jobs_list_attachments to discover job attachments.
Inputs: path. Returns: object
dispatch_installed_equipment_attachments_getARead-onlyIdempotent
Request an installed-equipment attachment by its ServiceTitan storage path. Returns the client-decoded attachment response; the pinned API does not define a response-body schema. Supply the exact known path; use dispatch_installed_equipment_get for the equipment record itself.
Inputs: path. Returns: object
dispatch_installed_equipment_getARead-onlyIdempotent
Retrieve one installed-equipment record by ID, including its location and equipment details. Use dispatch_installed_equipment_list to search by location, IDs, active state, or date ranges.
Inputs: id (required). Returns: object
dispatch_installed_equipment_listARead-onlyIdempotent
Search installed-equipment records by IDs, location IDs, active state, or created and modified ranges. Returns one page; use dispatch_installed_equipment_get for a known ID.
Inputs: ids, page, sort, active, +7 more. Returns: object
dispatch_job_cancel_reasons_listARead-onlyIdempotent
Browse the paginated job-cancellation-reason catalog using active and date filters. Use dispatch_jobs_cancel_reasons_list instead only to look up a supplied set of known reason IDs.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
dispatch_job_hold_reasons_listARead-onlyIdempotent
List one page of job-hold-reason catalog entries, filtered by active state or created and modified ranges. Returned records provide reason IDs and metadata used when placing a job on hold; they are distinct from cancellation reasons.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
dispatch_jobs_booked_log_getARead-onlyIdempotent
Retrieve booking-log details for a known job ID as one unpaged audit resource. Use dispatch_jobs_get for the current job record rather than its booking audit data.
Inputs: id (required). Returns: object
dispatch_jobs_canceled_logs_listARead-onlyIdempotent
List one page of cancellation log entries for a known job ID. Use this for cancellation audit details rather than the current job or cancellation-reason catalog.
Inputs: id (required), page, pageSize, includeTotal. Returns: object
dispatch_jobs_cancel_reasons_listARead-onlyIdempotent
Look up job cancellation reasons for a supplied list of known IDs. This non-paginated Jobs endpoint is distinct from dispatch_job_cancel_reasons_list, which browses and filters the reason catalog.
Inputs: ids. Returns: object
dispatch_jobs_custom_field_types_listARead-onlyIdempotent
List one page of custom-field type definitions available to jobs, with created and modified date filters. This returns field metadata, not values for one job.
Inputs: page, sort, pageSize, includeTotal, +4 more. Returns: object
dispatch_jobs_equipment_getARead-onlyIdempotent
Retrieve the installed-equipment ID collection attached to a known job as one unpaged response. Use dispatch_installed_equipment_get or list to fetch the equipment records themselves.
Inputs: id (required). Returns: object
dispatch_jobs_getARead-onlyIdempotent
Retrieve one job record by ID, optionally scoped to an external-data application. Returns the current ServiceTitan job data; use dispatch_jobs_list to search by customer, location, status, dates, or other filters.
Inputs: id (required), externalDataApplicationGuid. Returns: object
dispatch_jobs_get_attachmentARead-onlyIdempotent
Retrieve one job-attachment resource from Forms v2 by attachment ID. Use dispatch_jobs_list_attachments to browse attachment metadata for a known job when the attachment ID is unknown.
Inputs: id (required). Returns: object
dispatch_jobs_history_getARead-onlyIdempotent
Retrieve the history response for a known job ID as one unpaged audit resource. Use dispatch_jobs_get for the current job record rather than its historical changes.
Inputs: id (required). Returns: object
dispatch_jobs_listARead-onlyIdempotent
Search jobs by IDs, number, customer, location, project, status, appointments, equipment, tags, dates, or other supported filters. Returns one page; use dispatch_jobs_get for a known job ID.
Inputs: ids, page, sort, number, +31 more. Returns: object
dispatch_jobs_list_attachmentsARead-onlyIdempotent
List one page of attachments for a known job, optionally filtered by creation time and sorted. Returned records identify files attached to that job.
Inputs: jobId (required), page, sort, pageSize, +3 more. Returns: object
dispatch_jobs_notes_listARead-onlyIdempotent
List one page of notes attached to a known job. Requires the job ID; this endpoint has pagination controls but no note-content filters.
Inputs: id (required), page, pageSize, includeTotal. Returns: object
dispatch_job_splits_by_jobs_listARead-onlyIdempotent
Search one page of job-split records across supplied job IDs, with activity and date filters. Use dispatch_job_splits_list when working with one job-scoped route.
Inputs: page, sort, active, jobIds, +6 more. Returns: object
dispatch_job_splits_listARead-onlyIdempotent
List one page of split records for a single required job ID, with activity and date filters. Use dispatch_job_splits_by_jobs_list to query splits across multiple jobs.
Inputs: jobId (required), page, sort, active, +6 more. Returns: object
dispatch_job_types_getARead-onlyIdempotent
Retrieve one job-type definition by ID, optionally scoped to an external-data application. Returns the configured defaults and associations for that type; use dispatch_job_types_list to search the catalog.
Inputs: id (required), externalDataApplicationGuid. Returns: object
dispatch_job_types_listARead-onlyIdempotent
Search job-type definitions by IDs, name, priority, duration, active state, external-data application, or date ranges. Returns one page of configured job types; use dispatch_job_types_get for a known ID.
Inputs: ids, name, page, active, +12 more. Returns: object
dispatch_projects_custom_field_types_listARead-onlyIdempotent
List one page of custom-field type definitions available to projects, with created and modified date filters. This returns field metadata, not values for one project.
Inputs: page, sort, pageSize, includeTotal, +4 more. Returns: object
dispatch_projects_getARead-onlyIdempotent
Retrieve one project record by ID, optionally scoped to an external-data application. Returns the current project data; use dispatch_projects_list to search by customer, location, status, dates, or linked work.
Inputs: id (required), externalDataApplicationGuid. Returns: object
dispatch_projects_listARead-onlyIdempotent
Search projects by IDs, customer, location, status, type, manager, dates, or linked jobs, appointments, and invoices. Returns one page; use dispatch_projects_get for a known ID.
Inputs: ids, page, sort, jobId, +24 more. Returns: object
dispatch_projects_notes_listARead-onlyIdempotent
List one page of notes attached to a known project. Requires the project ID; use dispatch_projects_get for the project record itself.
Inputs: id (required), page, pageSize, includeTotal. Returns: object
dispatch_project_statuses_getARead-onlyIdempotent
Retrieve one project-status definition by ID, including its configured status metadata. Use dispatch_project_statuses_list to search the catalog and the sub-status list for finer classifications.
Inputs: id (required). Returns: object
dispatch_project_statuses_listARead-onlyIdempotent
Search one page of project-status definitions by IDs, name, or created and modified ranges. Use the returned status IDs to classify projects, and dispatch_project_sub_statuses_list to find their finer-grained sub-statuses.
Inputs: ids, name, page, sort, +6 more. Returns: object
dispatch_project_sub_statuses_getARead-onlyIdempotent
Retrieve one project sub-status definition by ID, including its parent-status metadata. Use dispatch_project_sub_statuses_list to search by parent status, name, IDs, active state, or dates.
Inputs: id (required). Returns: object
dispatch_project_sub_statuses_listARead-onlyIdempotent
Search one page of project sub-status definitions by parent status, IDs, name, active state, or date ranges. Returned records refine a project's status; use dispatch_project_statuses_list for the parent status catalog.
Inputs: ids, name, page, sort, +8 more. Returns: object
dispatch_project_types_getARead-onlyIdempotent
Retrieve one project-type definition by ID, including its configured type metadata. Use dispatch_project_types_list to browse the paginated type catalog when the ID is unknown.
Inputs: id (required). Returns: object
dispatch_project_types_listARead-onlyIdempotent
List one page of project-type definitions. Use dispatch_project_types_get when a project-type ID is already known.
Inputs: page, pageSize, includeTotal. Returns: object
estimates_estimate_templates_getARead-onlyIdempotent
Retrieve an estimate template by its ServiceTitan ID. Returns the single upstream record without pagination; use estimates_estimate_templates_list to search when the ID is unknown.
Inputs: id (required). Returns: object
estimates_estimate_templates_listARead-onlyIdempotent
List one requested page of estimate templates, filterable by active state and modified timestamps. Use estimates_estimate_templates_get for a known template ID; use estimates_list for customer estimates created from templates.
Inputs: page, active, pageSize, includeTotal, +2 more. Returns: object
estimates_export_estimatesARead-onlyIdempotent
Read the incremental estimate export feed for synchronization. Supply from as the change-window start and continue with the response continuation token when present; use estimates_list for interactive filtered browsing and estimates_get for a known ID.
Inputs: from, includeRecentChanges. Returns: object
estimates_getARead-onlyIdempotent
Retrieve a single estimate by its ServiceTitan ID. Returns the single upstream record without pagination; use estimates_list to search when the ID is unknown.
Inputs: id (required). Returns: object
estimates_items_listARead-onlyIdempotent
Search one requested page of estimate line items by estimate ID, item IDs, active state, or creation and modification dates. Each result represents an item attached to an estimate, rather than an estimate header returned by estimates_list.
Inputs: ids, page, active, pageSize, +6 more. Returns: object
estimates_listARead-onlyIdempotent
Search one requested page of estimates by job, project, location, status, dates, salesperson, or total amount. Use estimates_get for one known estimate; use estimates_export_estimates for incremental synchronization.
Inputs: ids, page, sort, jobId, +19 more. Returns: object
estimates_proposal_templates_getARead-onlyIdempotent
Retrieve a proposal template by its ServiceTitan ID. Returns the single upstream record without pagination; use estimates_proposal_templates_list to search when the ID is unknown.
Inputs: id (required). Returns: object
estimates_proposal_templates_listARead-onlyIdempotent
List one requested page of proposal templates, filterable by active state, modified timestamps, and proposal type ID. Use estimates_proposal_templates_get for a known template and estimates_proposal_types_list to resolve the type filter.
Inputs: page, active, pageSize, includeTotal, +3 more. Returns: object
estimates_proposal_types_listARead-onlyIdempotent
List proposal-type definitions available for grouping and filtering proposal templates. Use estimates_proposal_templates_list to retrieve the templates that reference these types.
Inputs: active. Returns: object
export_activitiesARead-onlyIdempotent
Read the incremental timesheet-activity export feed for cross-domain bulk synchronization. This is the same feed as settings_activities_export; use whichever name is available and do not fetch both. Continue immediately with continueFrom while hasMore is true; when false, retain it and wait before polling again. includeRecentChanges may repeat records.
Inputs: from, includeRecentChanges. Returns: object
export_activity_codesARead-onlyIdempotent
Read the incremental activity-code export feed for cross-domain bulk synchronization. This is the same feed as settings_activity_codes_export; use whichever name is available and do not fetch both. Continue immediately with continueFrom while hasMore is true; when false, retain it and wait before polling again. includeRecentChanges may repeat records.
Inputs: from, includeRecentChanges. Returns: object
export_adjustmentsARead-onlyIdempotent
Read the incremental adjustments export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_appointment_assignmentsARead-onlyIdempotent
Read the incremental appointment assignments export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_appointmentsARead-onlyIdempotent
Read the incremental appointments export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_bookingsARead-onlyIdempotent
Read the incremental bookings export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_business_unitsARead-onlyIdempotent
Read the incremental business units export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_callsARead-onlyIdempotent
Read the incremental calls export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_customersARead-onlyIdempotent
Read the incremental customers export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_customers_contactsARead-onlyIdempotent
Read the incremental customers contacts export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_employeesARead-onlyIdempotent
Read the incremental employee export feed for cross-domain bulk synchronization. This is the same feed as people_employees_export; use whichever name is available and do not fetch both. Continue immediately with continueFrom while hasMore is true; when false, retain it and wait before polling again. includeRecentChanges may repeat records.
Inputs: from, includeRecentChanges. Returns: object
export_equipmentARead-onlyIdempotent
Read the incremental equipment export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_gross_pay_itemsARead-onlyIdempotent
Read the incremental gross pay items export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_installed_equipmentARead-onlyIdempotent
Read the incremental installed equipment export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_inventory_billsARead-onlyIdempotent
Read the incremental inventory bills export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_invoice_itemsARead-onlyIdempotent
Read the incremental invoice items export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_invoicesARead-onlyIdempotent
Read the incremental invoices export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_invoice_templatesARead-onlyIdempotent
Read the incremental invoice templates export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_job_canceled_logsARead-onlyIdempotent
Read the incremental job canceled logs export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_job_historyARead-onlyIdempotent
Read the incremental job history export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_job_notesARead-onlyIdempotent
Read the incremental job notes export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_jobsARead-onlyIdempotent
Read the incremental jobs export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_job_splitsARead-onlyIdempotent
Read the incremental job splits export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_leadsARead-onlyIdempotent
Read the incremental leads export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_locationsARead-onlyIdempotent
Read the incremental locations export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_locations_contactsARead-onlyIdempotent
Read the incremental locations contacts export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_materialsARead-onlyIdempotent
Read the incremental materials export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_membershipsARead-onlyIdempotent
Read the incremental memberships export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_membership_status_changesARead-onlyIdempotent
Read the incremental membership status changes export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_membership_typesARead-onlyIdempotent
Read the incremental membership types export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_paymentsARead-onlyIdempotent
Read the incremental payments export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_payroll_adjustmentsARead-onlyIdempotent
Read the incremental payroll adjustments export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_payroll_settingsARead-onlyIdempotent
Read the incremental payroll settings export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_project_notesARead-onlyIdempotent
Read the incremental project notes export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_projectsARead-onlyIdempotent
Read the incremental projects export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_purchase_ordersARead-onlyIdempotent
Read the incremental purchase orders export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_recurring_service_typesARead-onlyIdempotent
Read the incremental recurring service types export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_returnsARead-onlyIdempotent
Read the incremental returns export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_service_agreementsARead-onlyIdempotent
Read the incremental service agreements export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_servicesARead-onlyIdempotent
Read the incremental services export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_tag_typesARead-onlyIdempotent
Read the incremental tag-type export feed for cross-domain bulk synchronization. This is the same feed as settings_tag_types_export; use whichever name is available and do not fetch both. Continue immediately with continueFrom while hasMore is true; when false, retain it and wait before polling again. includeRecentChanges may repeat records.
Inputs: from, includeRecentChanges. Returns: object
export_techniciansARead-onlyIdempotent
Read the incremental technicians export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_timesheet_codesARead-onlyIdempotent
Read the incremental timesheet codes export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
export_transfersARead-onlyIdempotent
Read the incremental transfers export feed for bulk synchronization. Start with a date or omit from to start at the beginning of the feed, continue immediately with continueFrom while hasMore is true, and when false retain it and wait before polling again. includeRecentChanges may return records sooner but can repeat them.
Inputs: from, includeRecentChanges. Returns: object
intel_campaign_performanceARead-onlyIdempotent
Compare marketing campaigns over the selected date range by combining all fetched call, booking, job, and invoice pages. Returns calls, bookings, booked-call conversion, attributed revenue, and revenue per call; campaignId narrows the analysis to one known campaign. The metrics reflect the wrapper's cross-source attribution logic, and partial source failures are returned in _warnings.
Examples:
"Which marketing campaigns are working?" -> startDate="2026-01-01", endDate="2026-03-10"
"How many calls are we getting from Google Ads?" -> startDate="2026-01-01", endDate="2026-03-10", campaignId=
"What's our call-to-booking rate?" -> startDate="2026-01-01", endDate="2026-03-10"
Inputs: endDate (required), startDate (required), limit, campaignId. Returns: object
intel_csr_performanceARead-onlyIdempotent
Summarize CSR-attributed jobs from Report 162 for the selected date range. Returns booked-job counts, revenue, average ticket, campaign and job-type mixes, rankings, and team averages; an optional business-unit name narrows matching report rows. Report execution is cached briefly and may wait for per-report/client spacing; unavailable source data is identified in _warnings.
Examples:
"How are our CSRs performing this month?" -> startDate="2026-03-01", endDate="2026-04-01"
"Show CSR booking revenue for last quarter" -> startDate="2025-10-01", endDate="2026-01-01"
"Which CSR is booking the most revenue for plumbing?" -> startDate="2026-01-01", endDate="2026-03-10", businessUnitName="Plumbing"
Inputs: endDate (required), startDate (required), businessUnitId, businessUnitName. Returns: object
intel_daily_snapshotARead-onlyIdempotent
Build a one-day operational snapshot in the configured tenant timezone from all fetched appointment, job, invoice, payment, estimate, and call pages plus Report 163 for the next day. Returns appointment progress, daily invoiced revenue and collections, sold-estimate value, call outcomes, highlights, and at most 20 upcoming jobs; truncation and partial source failures appear in _warnings. Results are cached for 60 seconds.
Examples:
"How did today go?" -> date="2026-03-10"
"Give me yesterday's numbers" -> date="2026-03-09"
"What happened on Monday?" -> date="2026-03-09"
Inputs: date. Returns: object
intel_estimate_pipelineARead-onlyIdempotent
Analyze all fetched estimate pages as an open, sold, and dismissed pipeline, with value, conversion, close speed, age buckets, and open estimates older than 30 days. startDate and endDate bound estimate creation timestamps; when both are supplied, Report 172 adds technician sales metrics. soldById filters both sources. Partial source failures are returned in _warnings.
Examples:
"What's our close rate on estimates?" -> startDate="2026-01-01", endDate="2026-03-10"
"Show me stale estimates over 30 days" -> returns staleEstimates automatically
"How is Andrew doing on sales?" -> soldById=<Andrew's ID>
Inputs: endDate, soldById, startDate. Returns: object
intel_invoice_trackingARead-onlyIdempotent
Track invoice email delivery for the selected date range by combining and deduplicating Reports 2281 and 2282. Returns sent and not-sent counts, send rate, invoice amount and balance impact, and unsent breakdowns by business unit and technician; an optional business-unit filter applies to both reports. Report calls may wait for per-report/client spacing, and partial source failures are returned in _warnings.
Examples:
"What percent of invoices were sent this week?" -> startDate="2026-03-02", endDate="2026-03-09"
"Which techs are not sending invoices?" -> startDate="2026-01-01", endDate="2026-03-10"
"Show invoice send rate for plumbing last month" -> startDate="2026-02-01", endDate="2026-03-01", businessUnitName="Plumbing"
Inputs: endDate (required), startDate (required), businessUnitId, businessUnitName. Returns: object
intel_labor_costARead-onlyIdempotent
Summarize employee regular, overtime, double-overtime, and total hours from Report 166 for the selected date range. When the tenant report exposes GrossPay, the tool also derives cost and effective hourly rate; otherwise those fields are unavailable rather than estimated. Report execution may wait for per-report/client spacing, and source failures are returned in _warnings.
Examples:
"What labor hours were reported this month?" -> startDate="2026-03-01", endDate="2026-04-01"
"Show overtime hours by employee for Q1" -> startDate="2026-01-01", endDate="2026-04-01"
Inputs: endDate (required), startDate (required), technicianId, businessUnitId, +2 more. Returns: object
intel_lookupARead-onlyIdempotent
Look up technicians, business units, payment types, or membership types for use in intelligence-tool filters. Returns matching IDs and names from a 30-minute in-process cache; search performs a case-insensitive name match, while omission returns the available cached set.
Examples:
"What are our business units?" -> type="business-units"
"Find technician named John" -> type="technicians", search="John"
"List all payment types" -> type="payment-types"
"What membership types do we have?" -> type="membership-types"
Inputs: type (required), search. Returns: object
intel_membership_healthARead-onlyIdempotent
Summarize membership activity from Report 182 and business-unit membership opportunities and conversions from Report 178 for the selected date range. Returns active-at-end counts, sales, cancellations, expirations, renewals, other status movements, and conversion metrics; it does not calculate a cohort retention rate. includeServiceRevenue adds tenant-wide invoice service revenue for the period, which is not membership-attributed. Partial source failures are returned in _warnings.
Examples:
"How are memberships doing this year?" -> startDate="2026-01-01", endDate="2026-03-10"
"Show membership status movements last quarter" -> startDate="2025-10-01", endDate="2026-01-01"
"How many new signups vs cancellations?" -> startDate="2026-01-01", endDate="2026-03-10"
Inputs: endDate (required), startDate (required), includeServiceRevenue. Returns: object
intel_revenue_summaryARead-onlyIdempotent
Summarize Report 175 revenue and Report 179 sales for the selected date range, optionally filtered to one business unit. Returns completed, non-job, adjustment, and total revenue plus opportunities, conversion, and sales metrics by business unit; the aggregate reflects returned report rows and is not certified as an all-company total or as matching every tenant dashboard configuration. includeProductivityMetrics adds Report 177 metrics, and includeCollections fetches all payment pages for the period. Report calls are cached briefly and serialized per report/client with at least 65 seconds between starts; a failed source is identified in _warnings and its affected metrics may be empty.
Examples:
"What was our total revenue last month?" -> startDate="2026-02-01", endDate="2026-03-01"
"How much did HVAC bring in this quarter?" -> startDate="2026-01-01", endDate="2026-04-01", businessUnitName="HVAC"
"Revenue year to date" -> startDate="2026-01-01", endDate="2026-03-10"
Inputs: endDate (required), startDate (required), businessUnitId, businessUnitName, +2 more. Returns: object
intel_technician_scorecardARead-onlyIdempotent
Build a technician scorecard for the selected date range from ServiceTitan technician reports. Returns revenue, converted jobs, opportunities, conversion, productivity, recalls, upsells, and lead-generation metrics; includeExtendedMetrics adds membership and tech/marketing-lead sales reports. Filter by technician or business unit when comparing a subset, and use limit to bound ranked results. Report calls may wait for per-report/client spacing, and partial source failures are returned in _warnings.
Examples:
"How are our techs performing this month?" -> startDate="2026-03-01", endDate="2026-04-01"
"Show me Andrew's numbers for Q1" -> startDate="2026-01-01", endDate="2026-04-01", technicianName="Andrew"
"Who is our top performer this year?" -> startDate="2026-01-01", endDate="2026-03-10"
Inputs: endDate (required), startDate (required), limit, technicianId, +4 more. Returns: object
inventory_purchase_order_markups_getARead-onlyIdempotent
Retrieve a purchase order markup by its ServiceTitan ID. Returns the single upstream record without pagination; use inventory_purchase_order_markups_list to search when the ID is unknown.
Inputs: id (required). Returns: object
inventory_purchase_order_markups_listARead-onlyIdempotent
List one requested page of purchase-order markup definitions, filterable by IDs and created or modified timestamps. Use inventory_purchase_order_markups_get for one known markup ID; use inventory_purchase_orders_list for purchase-order transactions.
Inputs: ids, page, sort, pageSize, +5 more. Returns: object
inventory_purchase_orders_getARead-onlyIdempotent
Retrieve a purchase order by its ServiceTitan ID. Returns the single upstream record without pagination; use inventory_purchase_orders_list to search when the ID is unknown.
Inputs: id (required). Returns: object
inventory_purchase_orders_listARead-onlyIdempotent
List one requested page of issued purchase orders using IDs, number, status, technician, job, project, and order or sent-date filters. Use inventory_purchase_orders_get for one known order and inventory_purchase_orders_requests_list for requests that precede issued orders.
Inputs: ids, page, sort, jobId, +15 more. Returns: object
inventory_purchase_orders_requests_listARead-onlyIdempotent
Search purchase-order requests with the exposed identifiers, status, date, technician, job, and paging filters. These are requests that may precede a purchase order; use inventory_purchase_orders_list for issued purchase orders.
Inputs: ids, page, sort, jobId, +13 more. Returns: object
inventory_purchase_order_types_listARead-onlyIdempotent
List one requested page of purchase-order type definitions, with active-state and created or modified timestamp filters. Use this catalog to interpret order classifications; use inventory_purchase_orders_list for issued purchase-order records.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
inventory_receipts_listARead-onlyIdempotent
List one requested page of inventory receipt transactions using IDs, number, vendor, purchase order, bill, business unit, inventory location, sync status, and received-date filters. Use inventory_purchase_orders_list for originating orders and inventory_returns_list for outbound vendor returns.
Inputs: ids, page, sort, active, +19 more. Returns: object
inventory_returns_listARead-onlyIdempotent
List one requested page of inventory return transactions using IDs, number, vendor, job, inventory location, sync status, return dates, and external-data filters. Use inventory_return_types_list for the separate return-type catalog; use inventory_transfers_list for movement between inventory locations.
Inputs: ids, page, sort, jobId, +22 more. Returns: object
inventory_return_types_listARead-onlyIdempotent
List one requested page of inventory return-type definitions, with active-state and created or modified timestamp filters. Use this catalog to interpret return classifications; use inventory_returns_list for actual return transactions.
Inputs: name, page, sort, pageSize, +6 more. Returns: object
inventory_transfers_listARead-onlyIdempotent
List one requested page of inventory transfers using IDs, number, status, transfer type, source and destination locations, dates, sync status, and external-data filters. Use this for stock moved between locations; use inventory_returns_list for stock returned to a vendor.
Inputs: ids, page, sort, number, +20 more. Returns: object
inventory_vendors_getARead-onlyIdempotent
Retrieve a vendor by its ServiceTitan ID. Returns the single upstream record without pagination; use inventory_vendors_list to search when the ID is unknown.
Inputs: id (required), externalDataKey, externalDataValues, externalDataApplicationGuid. Returns: object
inventory_vendors_listARead-onlyIdempotent
List one requested page of inventory vendors using IDs, active state, created or modified timestamps, and external-data mapping filters. Use inventory_vendors_get for one known vendor; use inventory_purchase_orders_list for purchase-order records.
Inputs: ids, page, sort, active, +9 more. Returns: object
inventory_warehouses_listARead-onlyIdempotent
List one requested page of warehouse definitions using IDs, active state, created or modified dates, and external-data mapping filters. Use this to resolve warehouse and inventory-location identifiers; use inventory transfers or purchase orders for stock movement and procurement.
Inputs: ids, page, sort, active, +9 more. Returns: object
marketing_attributed_leads_getARead-onlyIdempotent
Search attributed leads within a required UTC time window, optionally filtered by lead type. Returns one page of leads linked to marketing attribution activity.
Inputs: toUtc (required), fromUtc (required), page, leadType, +2 more. Returns: object
marketing_calls_getARead-onlyIdempotent
Retrieve one Marketing Calls v2 call record by numeric ID, including the call details returned by ServiceTitan. Use a call-list tool when the ID is unknown, and the recording or voicemail tools for those media resources.
Inputs: id (required). Returns: object
marketing_calls_recording_getARead-onlyIdempotent
Request the audio recording for a known Marketing Calls v2 call ID. ServiceTitan documents an audio/mpeg stream, but this wrapper delivers client-decoded data through its standard JSON/text envelope; use a binary-capable API client when faithful audio bytes are required. Use marketing_calls_get for the call record itself.
Inputs: id (required). Returns: object
marketing_calls_v2_listARead-onlyIdempotent
Search calls through Marketing Calls v2 using its activeOnly flag, explicit orderBy and direction, numeric ID array, agents, campaign, duration, phone, or timestamps. Returns one page; prefer v3 unless these v2-specific filter or sorting semantics are required.
Inputs: ids, page, agentId, orderBy, +16 more. Returns: object
marketing_calls_v3_listARead-onlyIdempotent
Search calls through Marketing Calls v3 using comma-delimited IDs, caller number, active state, agents, campaign, duration, timestamps, or sort. Returns one page; prefer this for ordinary call search, and use v2 only for its numeric ID array, activeOnly, or orderBy contract.
Inputs: ids, page, sort, active, +16 more. Returns: object
marketing_calls_voice_mail_getARead-onlyIdempotent
Request the voicemail audio for a known Marketing Calls v2 call ID. ServiceTitan documents an audio/mpeg stream, but this wrapper delivers client-decoded data through its standard JSON/text envelope; use a binary-capable API client when faithful audio bytes are required. Use marketing_calls_get for the call record itself.
Inputs: id (required). Returns: object
marketing_campaign_costs_getARead-onlyIdempotent
Retrieve one campaign-cost record by cost ID. Use marketing_campaign_costs_list to search when the cost ID is unknown.
Inputs: id (required). Returns: object
marketing_campaign_costs_listARead-onlyIdempotent
Search campaign costs across campaigns by campaign ID, year, or month. Returns one page; use marketing_campaigns_costs_list when a specific campaign ID is the required path scope.
Inputs: page, sort, year, month, +3 more. Returns: object
marketing_campaigns_costs_listARead-onlyIdempotent
List one page of costs for a required campaign ID, optionally filtered by year or month. Use marketing_campaign_costs_list for a broader cost search across campaigns.
Inputs: id (required), page, sort, year, +3 more. Returns: object
marketing_campaigns_getARead-onlyIdempotent
Retrieve one marketing campaign record by ID, including its configured campaign data. Use marketing_campaigns_list to search by name, phone number, active state, IDs, or date ranges.
Inputs: id (required). Returns: object
marketing_campaigns_listARead-onlyIdempotent
Search campaigns by IDs, name, phone number, active state, or created and modified ranges. Returns one page; use marketing_campaigns_get for a known campaign ID.
Inputs: ids, name, page, sort, +8 more. Returns: object
marketing_client_side_data_getARead-onlyIdempotent
Retrieve tenant task reference data: employees, business units, priorities, statuses, types, sources, and resolutions. This Task Management client-side-data operation returns one unpaged response with no inputs; use it to populate task filters or forms, not for marketing analytics.
Inputs: no named parameters. Returns: object
marketing_client_specific_pricing_get_all_rate_sheetsARead-onlyIdempotent
Search client-specific pricing rate sheets by IDs, search term, or active state. Returns one page of pricing definitions; despite the legacy name, pagination still applies. Use the rate-sheet ID from this result when updating a sheet.
Inputs: ids, page, active, pageSize, +2 more. Returns: object
marketing_opt_in_outs_listARead-onlyIdempotent
Retrieve the tenant's marketing phone opt-out records from the v3 opt-in/out endpoint. This operation accepts no filters or pagination inputs.
Inputs: no named parameters. Returns: object
marketing_reviewsARead-onlyIdempotent
Search customer review records by text, rating, source, response type, review status, location, technician, campaign, and date ranges. Returns one page; use inclusion flags when reviews missing those associations must remain in the result.
Inputs: page, sort, search, toDate, +19 more. Returns: object
marketing_scheduler_scheduler_performanceARead-onlyIdempotent
Retrieve one scheduler's performance metrics over a required session-created time window. Returns the scheduler performance response for that exact ID and period; use marketing_scheduler_schedulersessions for individual sessions.
Inputs: id (required), sessionCreatedBefore (required), sessionCreatedOnOrAfter (required). Returns: object
marketing_scheduler_schedulersARead-onlyIdempotent
List one page of marketing scheduler records, optionally filtered by created or modified timestamps. Use marketing_scheduler_scheduler_performance for metrics about one known scheduler.
Inputs: page, pageSize, includeTotal, createdBefore, +3 more. Returns: object
marketing_scheduler_schedulersessionsARead-onlyIdempotent
List one page of sessions for a known scheduler, optionally filtered by created or modified timestamps. Use scheduler performance when aggregated metrics are needed.
Inputs: id (required), page, pageSize, includeTotal, +4 more. Returns: object
memberships_custom_fields_listARead-onlyIdempotent
List one requested page of membership custom-field definitions using created and modified timestamp filters. Use this for field metadata; use memberships_list for customer membership records and their field values.
Inputs: page, sort, pageSize, includeTotal, +4 more. Returns: object
memberships_getARead-onlyIdempotent
Retrieve a single customer membership by its ServiceTitan ID. Returns the single upstream record without pagination; use memberships_list to search when the ID is unknown.
Inputs: id (required). Returns: object
memberships_listARead-onlyIdempotent
List one requested page of customer membership records using membership and customer IDs, status, active state, billing frequency, duration, and created or modified timestamps. Use memberships_get for one known sold membership and memberships_types_list for reusable membership-plan definitions.
Inputs: ids, page, active, status, +9 more. Returns: object
memberships_recurring_service_events_listARead-onlyIdempotent
List one requested page of recurring-service events using event IDs, status, job, location, and created or modified timestamp filters. Use memberships_recurring_services_get for the parent service record; use job tools for a job referenced by an event.
Inputs: ids, page, jobId, status, +7 more. Returns: object
memberships_recurring_services_getARead-onlyIdempotent
Retrieve a recurring service by its ServiceTitan ID. Returns the single upstream record without pagination; use memberships_recurring_services_list to search when the ID is unknown.
Inputs: id (required). Returns: object
memberships_recurring_services_listARead-onlyIdempotent
List one requested page of customer-location recurring services using service, membership, and location IDs, active state, and created or modified timestamps. Use memberships_recurring_services_get for one known service and memberships_types_recurring_service_items_list for plan-level service configuration.
Inputs: ids, page, active, pageSize, +7 more. Returns: object
memberships_recurring_service_types_getARead-onlyIdempotent
Retrieve a recurring service type by its ServiceTitan ID. Returns the single upstream record without pagination; use memberships_recurring_service_types_list to search when the ID is unknown.
Inputs: id (required). Returns: object
memberships_recurring_service_types_listARead-onlyIdempotent
List one requested page of recurring-service type definitions using IDs, membership type, recurrence type, duration type, active state, and created or modified timestamps. Use memberships_recurring_service_types_get for one known type and memberships_recurring_services_list for customer-location service instances.
Inputs: ids, page, sort, active, +9 more. Returns: object
memberships_service_agreements_getARead-onlyIdempotent
Retrieve a service agreement by its ServiceTitan ID. Returns the single upstream record without pagination; use memberships_service_agreements_list to search when the ID is unknown.
Inputs: id (required). Returns: object
memberships_service_agreements_listARead-onlyIdempotent
List one requested page of customer service agreements using agreement, customer, business-unit, status, and created or modified timestamp filters. Use memberships_service_agreements_get for a known agreement; use memberships_list for customer membership sales rather than agreement records.
Inputs: ids, page, sort, status, +8 more. Returns: object
memberships_status_changes_listARead-onlyIdempotent
Retrieve the status-change history attached to one required customer membership ID. Use memberships_get for the current membership record or memberships_list when the membership ID must be discovered first.
Inputs: id (required). Returns: object
memberships_types_discounts_listARead-onlyIdempotent
Retrieve discounts configured for one known membership type ID. These are type-level benefits, not the tenant pricebook discount-and-fee catalog.
Inputs: id (required). Returns: object
memberships_types_duration_billing_listARead-onlyIdempotent
Retrieve duration and billing configurations under one required membership-type ID. Use this for plan-level term and billing choices; use memberships_types_get for the parent plan and memberships_list for customer memberships.
Inputs: id (required), active. Returns: object
memberships_types_getARead-onlyIdempotent
Retrieve a membership type by its ServiceTitan ID. Returns the single upstream record without pagination; use memberships_types_list to search when the ID is unknown.
Inputs: id (required). Returns: object
memberships_types_listARead-onlyIdempotent
List one requested page of membership-type definitions using IDs, active state, billing frequency, duration, and created or modified timestamps; includeDurationBilling controls embedded billing details. Use memberships_types_get for one known plan and memberships_list for memberships sold to customers.
Inputs: ids, page, active, duration, +8 more. Returns: object
memberships_types_recurring_service_items_listARead-onlyIdempotent
Retrieve the recurring-service items configured under one required membership-type ID. Use memberships_types_get for the parent plan; use memberships_recurring_services_list for recurring services scheduled for customer locations.
Inputs: id (required). Returns: object
payroll_employees_payrolls_listARead-onlyIdempotent
List one requested page of payroll periods for a required employee, with status, active-state, and date filters. Use payroll_payrolls_list for a tenant-wide search.
Inputs: employeeId (required), page, active, status, +9 more. Returns: object
payroll_gross_pay_items_listARead-onlyIdempotent
List one requested page of gross-pay line items, optionally scoped by employee, payroll IDs, or pay date range. Use this to inspect pay components rather than payroll-period summaries.
Inputs: page, pageSize, employeeId, payrollIds, +4 more. Returns: object
payroll_payroll_adjustments_getARead-onlyIdempotent
Retrieve one payroll adjustment by its required ID. Use payroll_payroll_adjustments_list to search when the ID is unknown.
Inputs: id (required), employeeType. Returns: object
payroll_payroll_adjustments_listARead-onlyIdempotent
List one requested page of payroll adjustments, optionally filtered by employee IDs and posted timestamp. Use payroll_payroll_adjustments_get for one known adjustment ID.
Inputs: page, pageSize, employeeIds, includeTotal, +2 more. Returns: object
payroll_payroll_settings_employee_getARead-onlyIdempotent
Retrieve payroll settings for one employee by the required employee ID. Use payroll_payroll_settings_list to search across workers when the ID is unknown.
Inputs: employeeId (required). Returns: object
payroll_payroll_settings_listARead-onlyIdempotent
List one requested page of payroll-setting records across employees and technicians, with active, employee-type, created, and modified filters. Use the employee or technician get tool when a worker ID is known.
Inputs: page, active, pageSize, employeeType, +5 more. Returns: object
payroll_payroll_settings_technician_getARead-onlyIdempotent
Retrieve payroll settings for one technician by the required technician ID. Use payroll_payroll_settings_list to search across workers when the ID is unknown.
Inputs: technicianId (required). Returns: object
payroll_payrolls_listARead-onlyIdempotent
List one requested page of payroll periods across employees, with employee type, status, active-state, and date filters. Use the employee- or technician-specific payroll tools when that worker ID is known.
Inputs: page, active, status, pageSize, +9 more. Returns: object
payroll_technicians_payrolls_listARead-onlyIdempotent
List one requested page of payroll periods for a required technician, with status, active-state, and date filters. Use payroll_payrolls_list for a tenant-wide search.
Inputs: technicianId (required), page, active, status, +9 more. Returns: object
payroll_timesheet_codes_getARead-onlyIdempotent
Retrieve one timesheet code by its required ID. Use payroll_timesheet_codes_list to search when the ID is unknown.
Inputs: id (required). Returns: object
payroll_timesheet_codes_listBRead-onlyIdempotent
Retrieve one requested page of timesheet codes. Use the available filters to narrow results and request subsequent pages explicitly.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
payroll_timesheets_job_listARead-onlyIdempotent
List one requested page of timesheets attached to a required job. Use this when the job ID is known; use payroll_timesheets_jobs_list to search across optional comma-delimited job IDs.
Inputs: jobId (required), page, sort, endedOn, +8 more. Returns: object
payroll_timesheets_jobs_listARead-onlyIdempotent
List one requested page of job timesheets across jobs, optionally filtered by comma-delimited job IDs. Use payroll_timesheets_job_list when retrieving timesheets for one required job.
Inputs: page, sort, jobIds, endedOn, +8 more. Returns: object
payroll_timesheets_non_job_listARead-onlyIdempotent
List one requested page of non-job timesheets, optionally filtered by employee, employee type, dates, or active state. These records are not attached to jobs; use the job timesheet tools for job labor.
Inputs: page, sort, active, pageSize, +7 more. Returns: object
people_employees_exportARead-onlyIdempotent
Read the incremental employee export feed for People synchronization. This is the same feed as export_employees; use whichever name is available and do not fetch both. Continue immediately with continueFrom while hasMore is true; when false, retain it and wait before polling again. includeRecentChanges may repeat records.
Inputs: from, includeRecentChanges. Returns: object
people_employees_getARead-onlyIdempotent
Retrieve one employee by its required ID. Use people_employees_list to search when the ID is unknown.
Inputs: id (required). Returns: object
people_employees_listARead-onlyIdempotent
List one requested page of employees, optionally filtered by IDs, user IDs, name, active state, or dates. Use the get tool for one known ID or the export feed for synchronization.
Inputs: ids, name, page, active, +7 more. Returns: object
people_performance_getARead-onlyIdempotent
Retrieve one requested page of marketing performance metrics for a UTC period, segmented by campaign, ad group, or keyword. Use this to compare acquisition performance at one selected grain.
Inputs: toUtc (required), fromUtc (required), performanceSegmentationType (required), page, +2 more. Returns: object
people_technicians_getARead-onlyIdempotent
Retrieve one technician by its required ID. Use people_technicians_list to search when the technician ID is unknown.
Inputs: id (required). Returns: object
people_technician_shifts_getARead-onlyIdempotent
Retrieve one technician shift by its required ID. Use people_technician_shifts_list to search when the shift ID is unknown.
Inputs: id (required). Returns: object
people_technician_shifts_listARead-onlyIdempotent
List one requested page of technician shifts, including normal, on-call, and time-off shifts. Filter by technician, time bounds, text, type, or active state; use the get tool for one known shift ID.
Inputs: page, sort, active, pageSize, +11 more. Returns: object
people_technicians_listARead-onlyIdempotent
List one requested page of technicians, optionally filtered by IDs, user IDs, name, active state, or dates. Use the get tool for one known ID or the export feed for synchronization.
Inputs: ids, name, page, active, +7 more. Returns: object
people_trucks_listARead-onlyIdempotent
List one requested page of inventory trucks, optionally filtered by IDs, active state, dates, or external-data mapping. externalDataKey and externalDataValues must be supplied together.
Inputs: ids, page, sort, active, +9 more. Returns: object
pricebook_categories_getARead-onlyIdempotent
Retrieve a pricebook category by its ServiceTitan ID. Returns the single upstream record without pagination; use pricebook_categories_list to search when the ID is unknown.
Inputs: id (required). Returns: object
pricebook_categories_listARead-onlyIdempotent
List one requested page of pricebook categories using category type, active state, and created or modified timestamps. Use pricebook_categories_get for one known category ID; use the service, material, or equipment list tool for sellable items.
Inputs: page, sort, active, pageSize, +6 more. Returns: object
pricebook_discounts_fees_getARead-onlyIdempotent
Retrieve a discount or fee by its ServiceTitan ID. Returns the single upstream record without pagination; use pricebook_discounts_fees_list to search when the ID is unknown.
Inputs: id (required), externalDataApplicationGuid. Returns: object
pricebook_discounts_fees_listARead-onlyIdempotent
List one requested page of pricebook discount and fee items using IDs, active state, created or modified timestamps, and external-data mappings. Use pricebook_discounts_fees_get for a known item; membership-type discounts are a separate plan-level benefit.
Inputs: ids, page, sort, active, +9 more. Returns: object
pricebook_equipment_getARead-onlyIdempotent
Retrieve equipment item by its ServiceTitan ID. Returns the single upstream record without pagination; use pricebook_equipment_list to search when the ID is unknown.
Inputs: id (required), externalDataApplicationGuid. Returns: object
pricebook_equipment_listARead-onlyIdempotent
List one requested page of equipment pricebook items using IDs, active state, created or modified timestamps, and external-data mappings. Use pricebook_equipment_get for a known pricebook item; use installed-equipment tools for equipment attached to customer locations.
Inputs: ids, page, sort, active, +9 more. Returns: object
pricebook_materials_cost_types_listARead-onlyIdempotent
List the material cost-type definitions available to pricebook material records; this operation has no filters or caller-managed paging. Use pricebook_materials_list for material items and inventory tools for stock transactions.
Inputs: no named parameters. Returns: object
pricebook_materials_getARead-onlyIdempotent
Retrieve a material by its ServiceTitan ID. Returns the single upstream record without pagination; use pricebook_materials_list to search when the ID is unknown.
Inputs: id (required), externalDataApplicationGuid. Returns: object
pricebook_materials_listARead-onlyIdempotent
List one requested page of material pricebook items using IDs, cost-type IDs, other-direct-cost state, active state, timestamps, and external-data mappings. Use pricebook_materials_get for a known item, pricebook_materials_cost_types_list for cost metadata, or inventory tools for stock movement.
Inputs: ids, page, sort, active, +11 more. Returns: object
pricebook_materials_markup_getARead-onlyIdempotent
Retrieve a material markup range by its ServiceTitan ID. Returns the single upstream record without pagination; use pricebook_materials_markup_list to search when the ID is unknown.
Inputs: id (required). Returns: object
pricebook_materials_markup_listARead-onlyIdempotent
List one requested page of configured material markup ranges using paging, sorting, and total-count controls. Use pricebook_materials_markup_get for a known range ID; use pricebook_materials_list for the material items those pricing rules affect.
Inputs: page, sort, pageSize, includeTotal. Returns: object
pricebook_services_getARead-onlyIdempotent
Retrieve a service by its ServiceTitan ID. Returns the single upstream record without pagination; use pricebook_services_list to search when the ID is unknown.
Inputs: id (required), externalDataApplicationGuid. Returns: object
pricebook_services_listARead-onlyIdempotent
List one requested page of service pricebook items using IDs, active state, created or modified timestamps, and external-data mappings. Use pricebook_services_get for one known item; use estimates or invoices for services quoted or sold on customer transactions.
Inputs: ids, page, sort, active, +9 more. Returns: object
reporting_dynamic_value_sets_getARead-onlyIdempotent
Resolve selectable values for a report dynamic-value-set identifier. Use values from the report definition to supply the required identifier and paging inputs when that report parameter offers dynamic choices.
Inputs: dynamicSetId (required), page, pageSize, includeTotal. Returns: object
reporting_report_categories_listARead-onlyIdempotent
List one requested page of report categories with paging and total-count controls. Start here to discover a category ID, then use reporting_reports_list for reports in that category and reporting_reports_get for a report parameter definition.
Inputs: page, pageSize, includeTotal. Returns: object
reporting_reports_data_createARead-onlyIdempotent
Execute one requested page of a known report and return the upstream report-data response. First inspect reporting_reports_get for that report's required parameter names, value types, and accepted formats; pass those entries in parameters, and use page, pageSize, and includeTotal to control this request. This generic reporting call is not subject to the intelligence tools' report scheduler or 65-second spacing.
Inputs: reportId (required), parameters (required), reportCategory (required), page, +2 more. Returns: object
reporting_reports_getARead-onlyIdempotent
Retrieve one report definition from a known category and report ID, including its parameter contract. Use reporting_reports_list to discover reports and reporting_reports_data_create to execute the selected definition.
Inputs: reportId (required), reportCategory (required). Returns: object
reporting_reports_listARead-onlyIdempotent
List report definitions within a known report category. Use reporting_report_categories_list to discover category IDs, then use reporting_reports_get for one report definition before executing it.
Inputs: reportCategory (required), page, pageSize, includeTotal. Returns: object
scheduling_appointment_assignments_listARead-onlyIdempotent
Find one page of technician-to-appointment assignments by assignment IDs, appointment IDs, job ID, active state, or creation and modification dates. Use dispatch_appointments_get or dispatch_appointments_list for the appointment records themselves; this tool returns the assignment relationships.
Inputs: ids, page, sort, jobId, +8 more. Returns: object
scheduling_business_hours_listARead-onlyIdempotent
Retrieve the tenant business-hours configuration used for scheduling availability. This returns configured hours rather than appointment records or calculated open capacity.
Inputs: no named parameters. Returns: object
scheduling_non_job_appointments_getARead-onlyIdempotent
Retrieve a non-job appointment by its ServiceTitan ID. Returns the single upstream record without pagination; use scheduling_non_job_appointments_list to search when the ID is unknown.
Inputs: id (required). Returns: object
scheduling_non_job_appointments_listARead-onlyIdempotent
List one requested page of non-job appointments using IDs, technician, timesheet code, schedule visibility, active state, start bounds, and created or modified timestamps. Use scheduling_non_job_appointments_get for a known appointment; use dispatch appointment tools for appointments attached to jobs.
Inputs: ids, page, sort, pageSize, +11 more. Returns: object
scheduling_teams_getARead-onlyIdempotent
Retrieve a team by its ServiceTitan ID. Returns the single upstream record without pagination; use scheduling_teams_list to search when the ID is unknown.
Inputs: id (required). Returns: object
scheduling_teams_listARead-onlyIdempotent
List one requested page of scheduling teams using includeInactive and created or modified timestamp filters. Use scheduling_teams_get for one known team ID; use scheduling appointment assignments for technician-to-appointment assignments rather than team definitions.
Inputs: page, sort, pageSize, includeTotal, +5 more. Returns: object
scheduling_zones_getARead-onlyIdempotent
Retrieve a zone by its ServiceTitan ID. Returns the single upstream record without pagination; use scheduling_zones_list to search when the ID is unknown.
Inputs: id (required). Returns: object
scheduling_zones_listARead-onlyIdempotent
List one requested page of scheduling zones using active state and created or modified timestamp filters. Use scheduling_zones_get for one known zone ID; use scheduling_business_hours_list for configured operating hours rather than geographic zone definitions.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
settings_activities_exportARead-onlyIdempotent
Read the incremental timesheet-activity export feed for Settings workflows. This is the same feed as export_activities; use whichever name is available and do not fetch both. Continue immediately with continueFrom while hasMore is true; when false, retain it and wait before polling again. includeRecentChanges may repeat records.
Inputs: from, includeRecentChanges. Returns: object
settings_activity_categories_exportARead-onlyIdempotent
Read the incremental activity-category export feed for Settings synchronization. Use the list or get tools for filtered browsing or a known ID. Continue immediately with continueFrom while hasMore is true; when false, retain it and wait before polling again. includeRecentChanges may repeat records.
Inputs: from, includeRecentChanges. Returns: object
settings_activity_categories_getARead-onlyIdempotent
Retrieve one timesheet activity category by its required ID. Use settings_activity_categories_list to search when the ID is unknown.
Inputs: id (required). Returns: object
settings_activity_categories_listARead-onlyIdempotent
List one requested page of timesheet activity categories with active-state, date, and sort controls. Use the get tool for one known category or the export feed for synchronization.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
settings_activity_codes_exportARead-onlyIdempotent
Read the incremental activity-code export feed for Settings workflows. This is the same feed as export_activity_codes; use whichever name is available and do not fetch both. Continue immediately with continueFrom while hasMore is true; when false, retain it and wait before polling again. includeRecentChanges may repeat records.
Inputs: from, includeRecentChanges. Returns: object
settings_activity_codes_getARead-onlyIdempotent
Retrieve one payroll activity code by its required ID. Use settings_activity_codes_list to search when the ID is unknown.
Inputs: id (required). Returns: object
settings_activity_codes_listARead-onlyIdempotent
List one requested page of payroll activity codes with active-state, date, and sort controls. Use the get tool for one known code or the export feed for synchronization.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
settings_activity_types_getARead-onlyIdempotent
Retrieve one timesheet activity type by its required ID. Use settings_activity_types_list to search when the ID is unknown.
Inputs: id (required). Returns: object
settings_activity_types_listARead-onlyIdempotent
List one requested page of timesheet activity types with active-state, date, and sort controls. Use the get tool for one known type ID.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
settings_business_units_getARead-onlyIdempotent
Retrieve one business unit by its required ID. Use settings_business_units_list to search when the ID is unknown.
Inputs: id (required), externalDataApplicationGuid. Returns: object
settings_business_units_listARead-onlyIdempotent
List one requested page of business units, optionally filtered by IDs, name, active state, dates, or external-data application. Use the get tool for one known ID or the export feed for synchronization.
Inputs: ids, name, page, active, +7 more. Returns: object
settings_tag_types_exportARead-onlyIdempotent
Read the incremental tag-type export feed for Settings workflows. This is the same feed as export_tag_types; use whichever name is available and do not fetch both. Continue immediately with continueFrom while hasMore is true; when false, retain it and wait before polling again. includeRecentChanges may repeat records.
Inputs: from, includeRecentChanges. Returns: object
settings_tag_types_listARead-onlyIdempotent
List one requested page of tag types with active-state, date, and sort controls. Use the export feed for incremental synchronization; this endpoint is for paginated browsing.
Inputs: page, sort, active, pageSize, +5 more. Returns: object
settings_tasks_getARead-onlyIdempotent
Retrieve one task by its required ID. Use settings_tasks_list to search when the ID is unknown.
Inputs: id (required), includeSubtasks. Returns: object
settings_tasks_listARead-onlyIdempotent
List one requested page of employee tasks using status, assignment, related-record, date, priority, and other filters. Use settings_tasks_get for one known task ID; statuses is preferred over deprecated isClosed.
Inputs: ids, name, page, sort, +27 more. Returns: object
settings_user_roles_listARead-onlyIdempotent
List one requested page of user roles, optionally filtered by IDs, name, active state, creation date, or employee type. Use this catalog to resolve role IDs and availability.
Inputs: ids, name, page, active, +5 more. Returns: object
st_health_checkARead-onlyIdempotent
Verify authentication and representative tenant read access. Use st_readiness_check for report and module compatibility.
Inputs: no named parameters. Returns: object
st_readiness_checkARead-onlyIdempotent
Read-only compatibility manifest: authentication, representative module read access, report fields/parameters and definition fingerprints. Does not certify write scopes or metric totals.
Inputs: reports. Returns: object
st_result_readARead-onlyIdempotent
Retrieve a stored large result as bounded JSON text chunks. Start at offset 0, concatenate text in nextOffset order, then parse JSON. Results expire after five minutes and belong to this session.
Inputs: resultId (required), offset. Returns: object
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 264 tools
There are multiple near-identical and explicitly duplicated tools, including export_employees/people_employees_export, export_activities/settings_activities_export, marketing_calls_v2_list/marketing_calls_v3_list, and dispatch_job_cancel_reasons_list/dispatch_jobs_cancel_reasons_list. Many descriptions try to disambiguate, but the sheer number of overlapping feeds and singular/plural variants makes misselection likely.
Most tools follow a readable lowercase snake_case domain_entity_verb pattern, but conventions are mixed: top-level export_* feeds coexist with *_export alias tools, v2/v3 suffixes appear inconsistently, and names like marketing_scheduler_schedulersessions or crm_bookings_provider_contacts_list break the rhythm. The naming is not chaotic, but it is not uniform enough for a higher score.
With 264 tools, this is an extreme count even for a broad ServiceTitan integration. The surface includes dozens of near-duplicate export feeds, catalog/list/get variants, and custom intel tools that could have been consolidated. This volume will overwhelm agents and makes tool selection impractical.
The read/list/export coverage is broad across CRM, dispatch, accounting, inventory, payroll, marketing, and pricebook, but the entire surface is read-only with no create, update, or delete operations. There are also odd gaps where entities only have exports or only have list/get tools, and several duplicate feeds suggest an incomplete or inconsistent lifecycle model.
Maintenance
Related MCP Connectors
MCP server for your apps' tools and custom tools, plus hosted AI agents and approval-gated workflows
Unified MCP Server is a remote MCP connector for AI agents and vertical AI products that provides access to 22,000+ authorized SaaS tools across 400+ integrations and 24 categories directly inside LLMs (Claude, GPT, Gemini, Cohere). Tools operate only on explicitly authorized customer connections, enabling agents to safely read and write against live third-party systems.
MCP server unifying ERPs, CRMs, APIs and knowledge base for Claude, ChatGPT and Gemini.
Hosted MCP server with managed OAuth for 15+ toolkits: Google Workspace, Fitbit, Oura, Kalshi, etc.
Related MCP Servers
- AlicenseDqualityDmaintenanceAn MCP server that allows AI assistants to interact with the ServiceTitan API, requiring client credentials for authentication.4ISC
- AlicenseNot gradedqualityDmaintenanceA remote MCP server that exposes the ServiceTitan API as tools, enabling Claude and other clients to manage customers, jobs, pricebook, invoicing, and more with write safety and built-in observability.MIT
- AlicenseCqualityBmaintenanceA comprehensive MCP server covering the full GoHighLevel API surface with 651 tools, enabling management of contacts, opportunities, calendars, invoices, and more through natural language, with multi-tenant support and read-only safety defaults.5001MIT
- AlicenseNot gradedqualityDmaintenanceGoverned MCP server for bank-grade agent tool access with RBAC, PII redaction, rate limiting, and audit logging.MIT