servicetitan
The ServiceTitan source uses the v2 REST APIs. It provides 82 selectable
resources across accounting, jobs, inventory, customers, and other ServiceTitan
API families. Shared pagination, projection, and checkpoint behavior have
regression coverage. Live tenant reads have not been validated.
Use servicetitan@v2 to select API v2. servicetitan resolves to this
default version.
Configuration
Create an application with read permissions for the resources you select and
connect it to the tenant. Credentials and app access must match the environment.
Filament obtains and renews a client-credentials access token and sends the
application key in
ST-App-Key. Connection testing reads the first jobs export
page. It does not establish access to every API family. See the official
API documentation.
Resources
The table lists the OAuth read scope required by each endpoint. Resource links open the corresponding ServiceTitan API reference. Enable the scopes for your selected resources on the ServiceTitan application associated with your credentials and tenant. Related resources can share a scope.
The default selection includes jobs, customers, common exports, and reference
streams. The added export feeds, bank deposits, credit memos, AP transactions,
expense transactions, inventory bills and receipts, journal summaries, and
payment and tax reference tables are available to select individually. Grant
each selected resource’s read scope on the ServiceTitan application.
Other ServiceTitan resources, including reporting and forms, are outside this
resource set.
Accounting and inventory relationships
journal_entries provides syncStatus, including OutOfSync, plus
versionId and lastSyncVersionId for checking whether an entry changed after
sync. journal_entry_details provides account, transaction, job, and pricebook
item detail. journal_entry_summaries provides totals by account and business
unit. The detail and summary endpoints are read for each journal entry with an
ID. Their rows include journalEntryId but have no API-provided line ID.
bank_deposit_transactions reads each deposit’s transactions and includes
bankDepositId. credit_memo_items links to credit_memos through
creditMemoId. AP bills and expense transactions include their items as JSON.
inventory_receipts uses the receipt list, which includes item GL accounts.
inventory_receipts_export uses the export feed, which includes serial numbers
on items but omits item GL accounts. The inventory bill list and export feed are
also separate selectable resources.
The ap_bills resource selects ServiceTitan’s ApBill bill type, while
inventory_bills has no bill type filter.
vendors, gl_accounts, inventory_templates, installed_equipment, and
equipment_systems provide reference and equipment data for interpreting
transactions and jobs. Vendor addresses, contact details, custom fields, and
external data remain JSON. Vendor external data for a particular application
requires an externalDataApplicationGuid selector, which this connector does
not expose.
Modes
All 82 resources support full reads. Incremental reads are available for 53 export and timestamp based resources. ServiceTitan export feeds use the opaquecontinueFrom token. non_job_timesheets and payrolls use
modifiedOnOrAfter and sort by modification time. Use incremental upsert for
mutable export records. The first incremental run reads the complete export
before saving a checkpoint.
Full reads are the only supported mode for these resources:
- Accounting resources other than
invoices,invoice_items,payments, andinventory_bills_export. vendors,inventory_templates, andinventory_receipts.job_types,campaigns,campaign_costs,campaign_categories,technician_shifts,non_job_appointments, andmembership_status_changes.technician_ratingsandpayroll_settings, which have no documented stable row ID. Use full replace when writing these resources.
journal_entries, journal_entry_details,
journal_entry_summaries, and payment_terms. ServiceTitan allows null IDs for
journal entries and payment terms, so these resources have no primary key.
Neither journal entry child resource has a stable line key. Full replace also
removes rows missing from current-state lists when ServiceTitan deletes records.
Use it for technician_shifts, which can be deleted upstream.
inventory_bills_export and inventory_receipts_export support incremental
reads. Their corresponding list resources support full reads only.
Behavior
Export requests useincludeRecentChanges=false, accepting ServiceTitan’s
approximately 15-minute export visibility delay. A saved export token advances
only after a successful run. Failed runs replay from the previous checkpoint.
Append writes can retain duplicates after a replay, so use upsert for mutable
export records.
Where supported, list requests include inactive records with active=Any or
activeOnly=false. Paginated lists use hasMore. Export feeds use
continueFrom. Requests share a 45-per-second limiter within each run and
retry throttling and server errors.
Header resources read after their line resources finish, so a sync never lands
a line whose header arrives only in the next one. invoices waits on
invoice_items, credit_memos on credit_memo_items, jobs on
appointments, job_canceled_logs, job_history and job_notes, projects
on project_notes, customers on customer_contacts, and locations on
location_contacts. Links across entities, such as an invoice’s job or an
appointment’s customer, are not ordered and can lead their target by one sync.
Nested arrays and objects remain JSON. Dates and times remain strings. Integer
IDs use 64-bit integers. Many accounting amounts are projected as strings to
preserve their decimal representation. The raw column retains unprojected properties.
job_history contains one row per job, with the complete history array.
Export upserts use Filament’s insertion-order version policy. If an export
returns an older version after a newer one, the older record can replace the
newer destination row. Keep separate tenants in separate destination tables or
namespaces.