ServiceTitan

aid: servicetitan
url: https://raw.githubusercontent.com/api-evangelist/servicetitan/refs/heads/main/apis.yml
apis:
  - aid: servicetitan:servicetitan-crm-api
    name: ServiceTitan CRM API
    tags:
      - CRM
      - Customers
      - Leads
      - Bookings
      - Field Service
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/crm/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
      - url: openapi/servicetitan-crm-api-openapi.yml
        type: OpenAPI
      - url: json-schema/servicetitan-customer-schema.json
        type: JSONSchema
      - url: json-schema/servicetitan-location-schema.json
        type: JSONSchema
      - url: json-ld/servicetitan-context.jsonld
        type: JSONLD
    description: >-
      Manage residential and commercial customer records, locations, contacts, leads, bookings, tags, and booking
      provider sessions. The CRM API is the primary entry point for customer-of-record data, address geocoding, and
      lead-to-customer conversion flows in ServiceTitan.
  - aid: servicetitan:servicetitan-jpm-api
    name: ServiceTitan Job Planning & Management API
    tags:
      - Jobs
      - Projects
      - Appointments
      - Field Service
      - Dispatch
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/jpm/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
      - url: openapi/servicetitan-jpm-api-openapi.yml
        type: OpenAPI
      - url: json-schema/servicetitan-job-schema.json
        type: JSONSchema
      - url: json-schema/servicetitan-project-schema.json
        type: JSONSchema
      - url: json-schema/servicetitan-appointment-schema.json
        type: JSONSchema
    description: >-
      Create, retrieve, update, hold, cancel, and reschedule jobs, projects, appointments, job types, call reasons, job
      cancel reasons, and job history. JPM is the operational core of ServiceTitan — every work order and recurring
      service rolls through this surface.
  - aid: servicetitan:servicetitan-dispatch-api
    name: ServiceTitan Dispatch API
    tags:
      - Dispatch
      - Scheduling
      - Capacity
      - Zones
      - Field Service
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/dispatch/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
      - url: openapi/servicetitan-dispatch-api-openapi.yml
        type: OpenAPI
    description: >-
      Manage technician shifts, appointment assignments, capacity windows, business hours, zones, arrival windows, and
      gps pings. Drives the dispatch board and integrates with Dispatch Pro automation.
  - aid: servicetitan:servicetitan-accounting-api
    name: ServiceTitan Accounting API
    tags:
      - Accounting
      - Invoices
      - Payments
      - Journal Entries
      - Tax Zones
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/accounting/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
      - url: openapi/servicetitan-accounting-api-openapi.yml
        type: OpenAPI
      - url: json-schema/servicetitan-invoice-schema.json
        type: JSONSchema
      - url: json-schema/servicetitan-payment-schema.json
        type: JSONSchema
    description: >-
      Read and write invoices, invoice items, AP credits, payments, payment terms, payment types, journal entries,
      journal entry details, tax zones, and GL accounts. Integrates with QuickBooks Online, QuickBooks Desktop, Sage
      Intacct, and Acumatica exports.
  - aid: servicetitan:servicetitan-pricebook-api
    name: ServiceTitan Pricebook API
    tags:
      - Pricebook
      - Services
      - Materials
      - Equipment
      - Pricing
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/pricebook/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
      - url: openapi/servicetitan-pricebook-api-openapi.yml
        type: OpenAPI
      - url: json-schema/servicetitan-service-schema.json
        type: JSONSchema
      - url: json-schema/servicetitan-material-schema.json
        type: JSONSchema
    description: >-
      CRUD over the pricebook — categories, services, materials, equipment, discounts and fees, images, and pricebook
      bulk operations. Powers Pricebook Pro dynamic pricing and technician-facing flat-rate presentations.
  - aid: servicetitan:servicetitan-inventory-api
    name: ServiceTitan Inventory API
    tags:
      - Inventory
      - Purchase Orders
      - Warehouses
      - Trucks
      - Supply Chain
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/inventory/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
      - url: openapi/servicetitan-inventory-api-openapi.yml
        type: OpenAPI
    description: >-
      Manage purchase orders, purchase order types, transfers, returns, adjustments, receipts, warehouses, trucks,
      vendors, and inventory bills. Backed by ServiceTitan's request-middleware-templates Liquid framework for
      supply-chain partner integrations.
  - aid: servicetitan:servicetitan-marketing-api
    name: ServiceTitan Marketing API
    tags:
      - Marketing
      - Campaigns
      - Attribution
      - Categories
      - Suppression
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/marketing/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Manage marketing campaigns, campaign categories, suppression lists, and attribution data that powers cost-per-lead
      and cost-per-booked-job reporting. Underpins Marketing Pro email and SMS campaigns.
  - aid: servicetitan:servicetitan-marketing-reputation-api
    name: ServiceTitan Marketing Reputation API
    tags:
      - Marketing
      - Reputation
      - Reviews
      - Sentiment
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/marketingreputation/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Retrieve aggregated customer reviews and reputation metrics across Google, Facebook, Yelp, BBB, and other
      connected review providers. Read-only API surfacing review text, ratings, sentiment, and response state.
  - aid: servicetitan:servicetitan-memberships-api
    name: ServiceTitan Memberships API
    tags:
      - Memberships
      - Recurring Services
      - Contracts
      - Subscriptions
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/memberships/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Manage membership types, customer memberships, membership invoice templates, recurring service types, and
      recurring service events. Drives the recurring revenue surface — maintenance agreements, club memberships, and
      annual tune-up plans.
  - aid: servicetitan:servicetitan-service-agreements-api
    name: ServiceTitan Service Agreements API
    tags:
      - Service Agreements
      - Contracts
      - Commercial
      - Renewals
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/serviceagreements/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Manage commercial service agreements — contract terms, billed locations, line items, renewal cadence, and invoice
      generation rules. Used by commercial trades for multi-site recurring service contracts.
  - aid: servicetitan:servicetitan-equipment-systems-api
    name: ServiceTitan Equipment Systems API
    tags:
      - Equipment
      - Installed Equipment
      - Assets
      - Field Service
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/equipmentsystems/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
      - url: openapi/servicetitan-equipment-systems-api-openapi.yml
        type: OpenAPI
    description: >-
      Read and write installed equipment records per customer location — make, model, serial, install date, warranty
      terms, attachments, and equipment history. The asset-of-record API for HVAC, plumbing, electrical, and
      refrigeration trades.
  - aid: servicetitan:servicetitan-forms-api
    name: ServiceTitan Forms API
    tags:
      - Forms
      - Submissions
      - Compliance
      - Field Capture
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/forms/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Retrieve form definitions and field-completed form submissions including photos, signatures, checkbox values, and
      free-text responses. Used for safety checklists, equipment commissioning, compliance audits, and post-service
      surveys.
  - aid: servicetitan:servicetitan-payroll-api
    name: ServiceTitan Payroll API
    tags:
      - Payroll
      - Timesheets
      - Adjustments
      - Compensation
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/payroll/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Manage payroll adjustments, gross-pay items, job splits, timesheet codes, activity codes, non-job timesheets, and
      payroll settings. Exports to ADP, Paychex, Gusto, Paylocity, and other downstream payroll providers.
  - aid: servicetitan:servicetitan-timesheets-api
    name: ServiceTitan Timesheets API
    tags:
      - Timesheets
      - Time Tracking
      - Activity
      - Payroll
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/timesheets/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Read and write timesheet entries, activity codes, and shift segments tying technician time to jobs, non-job
      activities, paid time off, and travel. Feeds the Payroll API and FieldRoutes reconciliation.
  - aid: servicetitan:servicetitan-reporting-api
    name: ServiceTitan Reporting API
    tags:
      - Reporting
      - Analytics
      - Custom Reports
      - Beta
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/reporting/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Run published custom reports with parameters and retrieve dynamic value sets used by report inputs. Lower rate
      limit than other surfaces — 1 of the same report per minute per tenant. Replaces fragile UI exports for BI
      pipelines.
  - aid: servicetitan:servicetitan-sales-estimates-api
    name: ServiceTitan Sales & Estimates API
    tags:
      - Sales
      - Estimates
      - Quotes
      - Proposals
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/sales/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Create and retrieve estimates, estimate items, and proposal templates. Backs the Proposal Builder feature used to
      convert leads into approved scopes of work — including good / better / best presentations from technicians in the
      field.
  - aid: servicetitan:servicetitan-customer-interactions-api
    name: ServiceTitan Customer Interactions API
    tags:
      - Customer Feedback
      - Technician Ratings
      - NPS
      - Surveys
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/customerinteractions/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Submit and retrieve post-service technician ratings and customer feedback. Powers the "How did we do?" SMS / email
      flow that aggregates into Marketing Reputation.
  - aid: servicetitan:servicetitan-settings-api
    name: ServiceTitan Settings API
    tags:
      - Settings
      - Business Units
      - Technicians
      - User Roles
      - Tenants
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/settings/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
      - url: openapi/servicetitan-settings-api-openapi.yml
        type: OpenAPI
    description: >-
      Manage business units, employees, technicians, user roles, employee permissions, tag types, and tenant-wide
      settings. The tenant configuration surface for every other API in the platform.
  - aid: servicetitan:servicetitan-task-management-api
    name: ServiceTitan Task Management API
    tags:
      - Tasks
      - Workflow
      - Internal Tickets
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/taskmanagement/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Create, update, and resolve internal tasks, task types, sub-tasks, and task statuses. Used for office-to-field
      handoffs, escalations, and back-office workflows that aren't customer jobs.
  - aid: servicetitan:servicetitan-telecom-api
    name: ServiceTitan Telecom API
    tags:
      - Telecom
      - Calls
      - Voice
      - Contact Center
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/telecom/v3/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Retrieve inbound and outbound call records, call recordings, call analytics, and call reasons. Powers Contact
      Center Pro reporting and Voice Agent transcript analysis.
  - aid: servicetitan:servicetitan-scheduling-pro-api
    name: ServiceTitan Scheduling Pro API
    tags:
      - Scheduling Pro
      - Online Booking
      - Schedulers
      - Sessions
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/schedulingpro/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Power online booking widgets — list configured schedulers, retrieve scheduler availability, create and update
      booking sessions. Backed by the Schedule Engine acquisition; required for customer-facing self-service scheduling.
  - aid: servicetitan:servicetitan-jbce-api
    name: ServiceTitan Job Booking & Capacity API
    tags:
      - Job Booking
      - Call Reasons
      - Capacity Estimation
      - Field Service
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/jbce/v2/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Retrieve call reasons, job booking call reason metadata, capacity-aware booking windows, and recommended slot
      suggestions. Bridges Telecom call intake with JPM job creation.
  - aid: servicetitan:servicetitan-webhooks-api
    name: ServiceTitan Webhooks API
    tags:
      - Webhooks
      - Events
      - Integration
    humanURL: https://developer.servicetitan.io/api-details/
    baseURL: https://api.servicetitan.io/webhooks/v1/{tenant}/
    properties:
      - url: https://developer.servicetitan.io/api-details/
        type: Documentation
    description: >-
      Manage webhook subscriptions for customer, job, appointment, invoice, payment, and membership lifecycle events. V1
      is closed to new subscriptions; V2 webhooks are in development. Polling-based change-tracking via
      `modifiedOnOrAfter` filters is the recommended interim pattern.
name: ServiceTitan
tags:
  - Field Service Management
  - Trades
  - HVAC
  - Plumbing
  - Electrical
  - Construction
  - CRM
  - Dispatch
  - Accounting
  - Pricebook
  - Marketing
  - Memberships
  - Webhooks
kind: contract
image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
access: 3rd-Party
common:
  - type: LinkedIn
    url: https://www.linkedin.com/company/servicetitan
  - url: https://github.com/servicetitan
    type: GitHubOrganization
  - url: https://developer.servicetitan.io/
    name: ServiceTitan Developer Portal
    type: Portal
  - url: https://developer.servicetitan.io/docs/welcome/
    name: Developer Welcome
    type: GettingStarted
  - url: https://developer.servicetitan.io/docs/apis
    name: APIs Overview
    type: Documentation
  - url: https://developer.servicetitan.io/api-details/
    name: API Reference
    type: Documentation
  - url: https://developer.servicetitan.io/docs/get-going-environments/
    name: Environments
    type: Documentation
  - url: https://developer.servicetitan.io/docs/faqs-apis-app-keys-client-keys/
    name: APIs, App Keys & Client Keys
    type: Documentation
  - url: https://partnerapis.servicetitan.io/apis/
    name: Partner APIs Portal
    type: Portal
  - url: https://help.servicetitan.com/how-to/get-started-with-apidev-portal-v2
    name: Get started with API dev portal V2
    type: GettingStarted
  - url: >-
      https://help.servicetitan.com/problem-solution/what-are-the-default-api-rate-limits-in-servicetitan-for-regular-apis-and
    name: Default API rate limits
    type: RateLimits
  - url: https://status.servicetitan.com/
    name: ServiceTitan Status
    type: StatusPage
  - url: https://www.servicetitan.com/
    name: ServiceTitan
    type: Portal
  - url: https://www.servicetitan.com/products
    name: Products
    type: Documentation
  - url: https://www.servicetitan.com/blog
    name: ServiceTitan Blog
    type: Blog
  - url: https://www.servicetitan.com/news
    name: ServiceTitan News
    type: Blog
  - url: https://www.servicetitan.com/about-us
    type: AboutUs
  - url: https://www.servicetitan.com/customer-stories
    type: CaseStudies
  - url: https://www.servicetitan.com/careers
    type: Careers
  - url: https://community.servicetitan.com/
    name: ServiceTitan Community
    type: Forum
  - url: https://www.servicetitan.com/legal/privacy-policy
    type: PrivacyPolicy
  - url: https://www.servicetitan.com/legal/terms-of-service
    type: TermsOfService
  - url: https://www.servicetitan.com/trust
    type: TrustCenter
  - url: https://www.servicetitan.com/pricing
    type: Pricing
  - url: https://www.servicetitan.com/contact
    type: ContactInfo
  - url: https://www.servicetitan.com/partners
    name: ServiceTitan Partners
    type: Partners
  - url: https://app.servicetitan.com/
    name: ServiceTitan App
    type: SignIn
  - url: https://github.com/servicetitan/request-middleware-templates
    name: Supply Chain Middleware Templates
    type: Tool
  - url: https://github.com/servicetitan/Stl.Fusion
    name: Stl.Fusion Real-Time Library
    type: Tool
  - url: https://www.postman.com/api-evangelist/servicetitan
    name: Postman Workspace (community)
    type: Documentation
  - url: https://www.servicetitan.com/products/integrations
    name: Marketplace
    type: Marketplace
  - url: https://www.servicetitan.com/products/conduit
    name: Conduit Integration Platform
    type: Documentation
  - url: https://www.servicetitan.com/products/fieldroutes
    name: FieldRoutes
    type: Documentation
  - url: https://www.servicetitan.com/products/aspire
    name: Aspire
    type: Documentation
  - url: https://www.servicetitan.com/products/convex
    name: Convex
    type: Documentation
  - url: https://www.servicetitan.com/products/atlas
    name: Atlas Data Platform
    type: Documentation
  - url: plans/servicetitan-plans-pricing.yml
    type: Plans
  - url: rate-limits/servicetitan-rate-limits.yml
    type: RateLimits
  - url: finops/servicetitan-finops.yml
    type: FinOps
  - url: vocabulary/servicetitan-vocabulary.yml
    type: Vocabulary
  - url: rules/servicetitan-rules.yml
    type: SpectralRules
  - type: Authentication
    data:
      model: OAuth 2.0 Client Credentials + Application Key
      tokenEndpoint:
        production: https://auth.servicetitan.io/connect/token
        integration: https://auth-integration.servicetitan.io/connect/token
      grantType: client_credentials
      headers:
        ST-App-Key: Application key from developer portal
        Authorization: Bearer {access_token}
      tenantHeader: tenant
      credentials:
        - Client ID (from tenant API Application Access)
        - Client Secret (from tenant API Application Access)
        - App Key (per app, from developer portal)
        - Tenant ID (per tenant)
  - type: Environments
    data:
      production:
        api: https://api.servicetitan.io/{module}/v2/{tenant-id}/
        auth: https://auth.servicetitan.io/connect/token
        app: https://go.servicetitan.com/
      integration:
        api: https://api-integration.servicetitan.io/{module}/v2/{tenant-id}/
        auth: https://auth-integration.servicetitan.io/connect/token
        description: Cloned from production data for existing customers; required for app certification
  - type: Features
    data:
      - All-in-one field service management for residential and commercial trades
      - 24 published REST API surfaces covering CRM, JPM, Dispatch, Accounting, Pricebook, Inventory, and more
      - OAuth 2.0 client-credentials authentication with per-tenant App Keys and Client IDs
      - >-
        Default rate limit of 60 calls per second per application per tenant; Reporting API limited to 1 of the same
        report per minute per tenant
      - Production and Integration (sandbox) environments with separate auth endpoints
      - >-
        Webhooks V1 (closed to new subscriptions) plus polling via `modifiedOnOrAfter` for change tracking; Webhooks V2
        in development
      - Developer Portal V2 with API & Webhook Reference, app key management, and request access flow
      - Tenant-scoped data — every API path includes the tenant ID and every request includes ST-App-Key
      - Marketplace of certified partner integrations (Conduit, Zapier, Celigo, Prismatic, Workato, Rollout)
      - >-
        Pro add-ons exposed via the same API surface: Marketing Pro, Dispatch Pro, Pricebook Pro, Scheduling Pro, Fleet
        Pro, Contact Center Pro, Field Pro, Voice Agent
      - Supply chain partner integrations through the open-source request-middleware-templates Liquid framework
      - >-
        Sister platforms — FieldRoutes (pest), Aspire (landscape), Convex (commercial sales) — share the ServiceTitan
        account but have separate API surfaces not yet documented in the public developer portal
    sources:
      - https://developer.servicetitan.io/
      - https://developer.servicetitan.io/docs/apis
      - https://developer.servicetitan.io/api-details/
      - >-
        https://help.servicetitan.com/problem-solution/what-are-the-default-api-rate-limits-in-servicetitan-for-regular-apis-and
      - https://www.servicetitan.com/products
      - https://github.com/servicetitan
    updated: '2026-05-25'
created: '2026-05-25T00:00:00.000Z'
modified: '2026-05-25'
position: Consuming
description: >-
  ServiceTitan is the operating system for the trades — all-in-one field service management software for residential and
  commercial contractors in HVAC, plumbing, electrical, roofing, garage door, pest control, refrigeration, fire & life
  safety, septic, landscape, and other service-based industries. The platform unifies CRM, dispatch, scheduling, job
  management, pricebook, mobile field execution, invoicing, payments, payroll, marketing attribution, memberships,
  service agreements, reporting, and Contact Center / Voice Agent capabilities behind a tenant-scoped V2 REST API
  surface accessed via OAuth 2.0 client credentials and a per-application App Key. ServiceTitan is the parent of
  FieldRoutes (pest), Aspire (landscape), and Convex (commercial sales), and ships Conduit as its integration platform.
maintainers:
  - FN: Kin Lane
    email: [email protected]
    X: apievangelist
    url: https://apievangelist.com
specificationVersion: '0.16'