- Category: scheduling & booking
- Auth: S2S_OAUTH2
- Composio-managed OAuth available? No
- Tools: 585
- Triggers: 0
- Slug:
SERVICETITAN - Version: 20261101_00
Tools
Activate Employee Account
Activate Employee Account
Activate Technician Account
Activate Technician Account
Add Credit Memo Splits
Add Credit Memo Splits
Add Customer Tag
Add Customer Tag
Add Equipment to Equipment System
Add Equipment to Equipment System
Add Location Tag
Add Location Tag
Approve Purchase Order Request
Approve Purchase Order Request
Assign Technician Skills
Assign Technician Skills
SERVICETITAN_ASSIGN_TECHNICIAN_SKILLSAssign existing skills to a ServiceTitan technician. With replace_existing_skills true the technician’s current skills are replaced by the given list; with false the list is added.Input Parameters
Output
Assign Technicians to Appointment
Assign Technicians to Appointment
Attach Job Equipment
Attach Job Equipment
SERVICETITAN_ATTACH_JOB_EQUIPMENTAttach one or more equipment items to a ServiceTitan job. Returns the full list of equipment IDs attached after the change. The spec does not say which equipment ids these are; they are not the equipment system ids of the equipment-system tools, and whether installed-equipment ids (LIST_INSTALLED_EQUIPMENT) or pricebook equipment ids (LIST_PRICEBOOK_EQUIPMENT) are meant is unverified.Input Parameters
Output
Attach Job to Project
Attach Job to Project
Bulk Create Installed Equipment
Bulk Create Installed Equipment
SERVICETITAN_BULK_CREATE_INSTALLED_EQUIPMENTCreate up to 1000 installed equipment records in ServiceTitan in one atomic request. If any record is invalid the whole batch is rolled back and nothing is created.Input Parameters
Output
Bulk Create Pricebook Items
Bulk Create Pricebook Items
SERVICETITAN_BULK_CREATE_PRICEBOOK_ITEMSCreate many ServiceTitan pricebook items in one request: services, equipment, materials, and discounts and fees. At least one of those four collections must contain an item. Give each item a customId; links inside the same request (serviceMaterials, recommendations, upgrades) can point to it by customId, and the response maps each customId to its new id.Input Parameters
Output
Bulk Delete Technician Shifts
Bulk Delete Technician Shifts
SERVICETITAN_BULK_DELETE_TECHNICIAN_SHIFTSDelete every ServiceTitan technician shift in a date range, for all technicians. The only criteria are start and end; there is no technician filter, so check the range with List Technician Shifts first.Input Parameters
Output
Bulk Update Pricebook Items
Bulk Update Pricebook Items
SERVICETITAN_BULK_UPDATE_PRICEBOOK_ITEMSUpdate many ServiceTitan pricebook items in one request: services, equipment, materials, and discounts and fees. At least one of those four collections must contain an item. Each item must carry its id and the documented full set of fields, not just the changed ones.Input Parameters
Output
Cancel Inventory Receipt
Cancel Inventory Receipt
SERVICETITAN_CANCEL_INVENTORY_RECEIPTCancel a ServiceTitan inventory receipt by id, optionally recording a cancellation reason. This cannot be undone through the API: no way to reopen a canceled inventory receipt is documented.Input Parameters
Output
Cancel Inventory Return
Cancel Inventory Return
Cancel Job
Cancel Job
Cancel Purchase Order
Cancel Purchase Order
Cancel Report Data Query
Cancel Report Data Query
Confirm Appointment
Confirm Appointment
Create Adjustment Invoice
Create Adjustment Invoice
SERVICETITAN_CREATE_ADJUSTMENT_INVOICECreate an adjustment invoice against an existing ServiceTitan invoice, such as for a refund or write-off. The result contains the integer returned by ServiceTitan; its meaning is not specified.Input Parameters
Output
Create Appointment
Create Appointment
SERVICETITAN_CREATE_APPOINTMENTAdd a new appointment to an existing ServiceTitan job, with start and end times and optional technicians. A job’s first appointment is created by Create Job; use this only for additional visits.Input Parameters
Output
Create Arrival Window
Create Arrival Window
SERVICETITAN_CREATE_ARRIVAL_WINDOWCreate a ServiceTitan arrival window with a start time and duration for a set of business units.Input Parameters
Output
Create Booking
Create Booking
SERVICETITAN_CREATE_BOOKINGCreate a booking in ServiceTitan, an incoming request that office staff later book as a job or dismiss. It does not create a job; send at least one phone or email in contacts so staff can follow up.Input Parameters
Output
Create Booking Contact
Create Booking Contact
SERVICETITAN_CREATE_BOOKING_CONTACTAdd a contact entry (phone, email or fax) to a booking in ServiceTitan for a given booking provider. This is the booking’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.Input Parameters
Output
Create Booking Provider Tag
Create Booking Provider Tag
Create Budget Code
Create Budget Code
Create Business Hours
Create Business Hours
Create Campaign
Create Campaign
Create Campaign Category
Create Campaign Category
Create Campaign Cost
Create Campaign Cost
Create Contact
Create Contact
Create Contact Method
Create Contact Method
SERVICETITAN_CREATE_CONTACT_METHODAdd a contact method (phone, mobile phone, email or fax) to a contact in ServiceTitan. contact_id is the GUID of a person contact from CREATE_CONTACT or LIST_CONTACTS; to add a phone or email directly to a customer, location or booking use CREATE_CUSTOMER_CONTACT, CREATE_LOCATION_CONTACT or CREATE_BOOKING_CONTACT.Input Parameters
Output
Create Contact Relationship
Create Contact Relationship
SERVICETITAN_CREATE_CONTACT_RELATIONSHIPLink a contact to a customer, location or booking in ServiceTitan. All three values go in the path and no request body is sent.Input Parameters
Output
Create Customer
Create Customer
Create Customer Contact
Create Customer Contact
SERVICETITAN_CREATE_CUSTOMER_CONTACTAdd a contact entry (phone, mobile phone, email or fax) to a customer in ServiceTitan. It is not copied to the customer’s locations. This is the customer’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.Input Parameters
Output
Create Customer Note
Create Customer Note
Create Employee
Create Employee
SERVICETITAN_CREATE_EMPLOYEECreate an office employee in ServiceTitan with a role and positions; returns the new employee id. account_creation_method picks CreateLater, SendInvite or AssignLoginAndPassword; the spec does not describe what each one does.Input Parameters
Output
Create Equipment System
Create Equipment System
Create Equipment Type
Create Equipment Type
Create Estimate
Create Estimate
SERVICETITAN_CREATE_ESTIMATECreate an estimate in ServiceTitan on a job or project, with its line items. Use it to quote work before it is sold; every field is optional in the spec, and which ones ServiceTitan actually needs (such as job_id or project_id) is not documented.Input Parameters
Output
Create Estimate Template
Create Estimate Template
SERVICETITAN_CREATE_ESTIMATE_TEMPLATECreate an estimate template in ServiceTitan from a list of pricebook items. Static templates need a unitPrice on every item; Dynamic templates take prices from the pricebook.Input Parameters
Output
Create External Call Attribution
Create External Call Attribution
SERVICETITAN_CREATE_EXTERNAL_CALL_ATTRIBUTIONAttribute a phone call tracked by outside call-tracking software to a web session in ServiceTitan Marketing Ads. It records attribution only; it does not create a call, lead or job.Input Parameters
Output
Create Finding
Create Finding
SERVICETITAN_CREATE_FINDINGCreate a finding in ServiceTitan to record an issue or observation at a customer location, with an urgency level and optional links to installed equipment and the job where it was found. Attachments link file URLs; no file content is uploaded.Input Parameters
Output
Create Finding Attachment
Create Finding Attachment
SERVICETITAN_CREATE_FINDING_ATTACHMENTAdd an attachment to a ServiceTitan finding by linking a file URL with a file name and media type. No file content is sent; the spec expects the URL returned by ServiceTitan’s findings upload endpoint, which is not available as a tool.Input Parameters
Output
Create GL Account
Create GL Account
Create GPS Pings
Create GPS Pings
SERVICETITAN_CREATE_GPS_PINGSSend GPS location pings for technician vehicles or units to ServiceTitan for a configured GPS provider, so they plot on the Dispatch Map. Returns a per-ping result; a ping can fail while the call succeeds.Input Parameters
Output
Create Gross Pay Item
Create Gross Pay Item
SERVICETITAN_CREATE_GROSS_PAY_ITEMCreate a gross pay item inside an existing payroll in ServiceTitan and return its id. payroll_id, amount, activity_code_id and date are required; find the payroll id with LIST_PAYROLLS.Input Parameters
Output
Create Installed Equipment
Create Installed Equipment
SERVICETITAN_CREATE_INSTALLED_EQUIPMENTCreate a record of equipment installed at a ServiceTitan customer location, with serial number, warranty dates, and an optional parent equipment or system. Only location_id is required.Input Parameters
Output
Create Inventory Adjustment
Create Inventory Adjustment
SERVICETITAN_CREATE_INVENTORY_ADJUSTMENTCreate an inventory adjustment in ServiceTitan that changes stock quantities at one inventory location. Only the types Adjustment, BeginningBalance, and Consignment can be created; item quantities may be negative.Input Parameters
Output
Create Inventory Receipt
Create Inventory Receipt
SERVICETITAN_CREATE_INVENTORY_RECEIPTRecord a receipt of items against an existing ServiceTitan purchase order. items lists each SKU received with its quantity and cost.Input Parameters
Output
Create Inventory Return
Create Inventory Return
Create Inventory Return Type
Create Inventory Return Type
SERVICETITAN_CREATE_INVENTORY_RETURN_TYPECreate a vendor return type in ServiceTitan inventory, with its vendor-credit, sales-tax and default settings. Its id is the return_type_id that CREATE_INVENTORY_RETURN requires.Input Parameters
Output
Create Invoice Task
Create Invoice Task
Create Invoice Template
Create Invoice Template
Create Job
Create Job
SERVICETITAN_CREATE_JOBBook a new ServiceTitan job for a customer and location, with at least one appointment. Customer and location must already exist; the job’s first appointment is created from the appointments list.Input Parameters
Output
Create Job Attribution
Create Job Attribution
SERVICETITAN_CREATE_JOB_ATTRIBUTIONAttribute an existing job to a web session in ServiceTitan Marketing Ads. It records attribution only; the job must already exist.Input Parameters
Output
Create Job Note
Create Job Note
Create Job Type
Create Job Type
SERVICETITAN_CREATE_JOB_TYPECreate a ServiceTitan job type with its name, priority, duration, business units, skills and default tags.Input Parameters
Output
Create Journal Entry
Create Journal Entry
SERVICETITAN_CREATE_JOURNAL_ENTRYCreate a journal entry with debit and credit lines in ServiceTitan; it is marked external automatically. status and version_id are required (the spec does not document what version_id a new entry should carry; unverified without a live account), and the documented response has no body, so the new id is not returned: find the entry with LIST_JOURNAL_ENTRIES.Input Parameters
Output
Create Labor Type
Create Labor Type
Create Lead
Create Lead
SERVICETITAN_CREATE_LEADCreate a lead in ServiceTitan. campaign_id and summary are required, and one of call_reason_id or follow_up_date must be sent; passing booking_id irreversibly dismisses that booking and turns it into this lead; ServiceTitan documents no operation to undo the dismissal. For a web-form style lead with just a name and contact details and no campaign id, use SUBMIT_LEAD_FORM.Input Parameters
Output
Create Lead Follow Up
Create Lead Follow Up
Create Lead Note
Create Lead Note
Create Location
Create Location
SERVICETITAN_CREATE_LOCATIONCreate a location (service address) in ServiceTitan under an existing customer. name, address and customer_id are required.Input Parameters
Output
Create Location Contact
Create Location Contact
SERVICETITAN_CREATE_LOCATION_CONTACTAdd a contact entry (phone, mobile phone, email or fax) to a location in ServiceTitan. The provider guide says an entry added to a new location is also copied to its customer. This is the location’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.Input Parameters
Output
Create Location Note
Create Location Note
Create Membership Sale Invoice
Create Membership Sale Invoice
SERVICETITAN_CREATE_MEMBERSHIP_SALE_INVOICESell a membership to a customer in ServiceTitan by creating a membership sale invoice; returns the new invoice id and customer membership id. It creates a real invoice and membership together, so call it only once the sale is confirmed. Setting recurring_service_action=None deletes the customer’s existing recurring services.Input Parameters
Output
Create Non Job Appointment
Create Non Job Appointment
SERVICETITAN_CREATE_NON_JOB_APPOINTMENTBlock time on a ServiceTitan technician’s schedule for a non-customer activity such as a meeting, training or time off, optionally repeating. For a customer visit use Create Appointment.Input Parameters
Output
Create Opt Outs
Create Opt Outs
SERVICETITAN_CREATE_OPT_OUTSOpt one or more phone numbers out of contact in ServiceTitan and return a result for each number. The whole request fails if any number cannot be parsed, and a number already opted out globally cannot be opted out for marketing.Input Parameters
Output
Create Partial Budget Code
Create Partial Budget Code
SERVICETITAN_CREATE_PARTIAL_BUDGET_CODECreate a partial ServiceTitan budget code from segment bindings, where a segment may be left without an item. Use Create Budget Code when every segment has an item.Input Parameters
Output
Create Payroll Adjustment
Create Payroll Adjustment
SERVICETITAN_CREATE_PAYROLL_ADJUSTMENTCreate a payroll adjustment, a manual earning or deduction for one employee or technician, in ServiceTitan and return its id. employee_type must match the kind of id given in employee_id.Input Parameters
Output
Create Pricebook Category
Create Pricebook Category
Create Pricebook Discount or Fee
Create Pricebook Discount or Fee
SERVICETITAN_CREATE_PRICEBOOK_DISCOUNT_OR_FEECreate a discount or a fee in the ServiceTitan pricebook. The type field decides which one, and amount_type decides whether the amount is a percentage or a fixed value.Input Parameters
Output
Create Pricebook Equipment
Create Pricebook Equipment
SERVICETITAN_CREATE_PRICEBOOK_EQUIPMENTCreate an equipment item in the ServiceTitan pricebook catalog, with pricing, warranty, vendors, and categories. This does not record equipment installed at a location; use CREATE_INSTALLED_EQUIPMENT for that.Input Parameters
Output
Create Pricebook Material
Create Pricebook Material
Create Pricebook Material Markup
Create Pricebook Material Markup
SERVICETITAN_CREATE_PRICEBOOK_MATERIAL_MARKUPCreate a material markup tier in the ServiceTitan pricebook: a from/to range and the markup percent applied to it. The documented body also requires an id value.Input Parameters
Output
Create Pricebook Service
Create Pricebook Service
SERVICETITAN_CREATE_PRICEBOOK_SERVICECreate a service in the ServiceTitan pricebook, with pricing, warranty, categories, and linked materials and equipment. Only code and description are required.Input Parameters
Output
Create Project
Create Project
SERVICETITAN_CREATE_PROJECTCreate a ServiceTitan project at a location to group related jobs. Only the location is required; jobs are added afterwards with Attach Job To Project.Input Parameters
Output
Create Project Note
Create Project Note
Create Proposal Template
Create Proposal Template
SERVICETITAN_CREATE_PROPOSAL_TEMPLATECreate a proposal template in ServiceTitan that assigns an estimate template to each option of a proposal type. Each proposal type option may appear only once in estimate_assignments.Input Parameters
Output
Create Purchase Order
Create Purchase Order
SERVICETITAN_CREATE_PURCHASE_ORDERCreate a purchase order in ServiceTitan for items ordered from a vendor. vendor_id, type_id, business_unit_id and inventory_location_id name existing records, and only the id of the new purchase order is returned.Input Parameters
Output
Create Purchase Order Markup
Create Purchase Order Markup
Create Purchase Order Type
Create Purchase Order Type
Create Subtask
Create Subtask
Create Tag Type
Create Tag Type
Create Task
Create Task
SERVICETITAN_CREATE_TASKCreate an office task in ServiceTitan Task Management, assigned to an employee. The type, source, business unit and employee ids come from GET_TASK_REFERENCE_DATA. These are Task Management tasks, not the invoice workflow tasks of CREATE_INVOICE_TASK / LIST_INVOICE_TASKS.Input Parameters
Output
Create Team
Create Team
Create Technician
Create Technician
SERVICETITAN_CREATE_TECHNICIANCreate a field technician in ServiceTitan with a role, positions and license type; returns the new technician id. Get role_id from LIST_USER_ROLES.Input Parameters
Output
Create Technician Rating
Create Technician Rating
Create Technician Shift
Create Technician Shift
SERVICETITAN_CREATE_TECHNICIAN_SHIFTCreate a ServiceTitan shift (Normal, OnCall or TimeOff) for one or more technicians, optionally repeating daily or weekly. Returns the list of shifts created.Input Parameters
Output
Create Technician Skill
Create Technician Skill
Create Timesheet Activity
Create Timesheet Activity
SERVICETITAN_CREATE_TIMESHEET_ACTIVITYCreate a timesheet activity, a block of recorded time for one employee or technician, in ServiceTitan and return its id. employee_id, employee_type, activity_type_id, start_time and tag_type_ids are required; end_time is optional.Input Parameters
Output
Create Truck
Create Truck
Create Vendor
Create Vendor
SERVICETITAN_CREATE_VENDORCreate an inventory vendor (supplier) in ServiceTitan. The vendor’s main address is required.Input Parameters
Output
Create Web Booking Attribution
Create Web Booking Attribution
SERVICETITAN_CREATE_WEB_BOOKING_ATTRIBUTIONAttribute an existing booking to a web session in ServiceTitan Marketing Ads. It records attribution only; the booking must already exist.Input Parameters
Output
Create Web Lead Form Attribution
Create Web Lead Form Attribution
SERVICETITAN_CREATE_WEB_LEAD_FORM_ATTRIBUTIONAttribute an existing lead captured from a web form to a web session in ServiceTitan Marketing Ads. It records attribution only; the lead must already exist.Input Parameters
Output
Create Zone
Create Zone
Deactivate Employee Account
Deactivate Employee Account
Deactivate Estimate Template
Deactivate Estimate Template
Deactivate Proposal Template
Deactivate Proposal Template
Deactivate Technician Account
Deactivate Technician Account
Delete Appointment
Delete Appointment
Delete Booking Contact
Delete Booking Contact
SERVICETITAN_DELETE_BOOKING_CONTACTRemove one contact entry from a booking in ServiceTitan for a given booking provider. The booking itself is kept.Input Parameters
Output
Delete Contact
Delete Contact
Delete Contact Method
Delete Contact Method
SERVICETITAN_DELETE_CONTACT_METHODDelete one contact method from a contact in ServiceTitan. contact_id is the GUID of a person contact from CREATE_CONTACT or LIST_CONTACTS; to add a phone or email directly to a customer, location or booking use CREATE_CUSTOMER_CONTACT, CREATE_LOCATION_CONTACT or CREATE_BOOKING_CONTACT.Input Parameters
Output
Delete Contact Relationship
Delete Contact Relationship
SERVICETITAN_DELETE_CONTACT_RELATIONSHIPRemove the link between a contact and a customer, location or booking in ServiceTitan. The contact itself is kept.Input Parameters
Output
Delete Customer Contact
Delete Customer Contact
Delete Customer Note
Delete Customer Note
Delete Equipment System
Delete Equipment System
Delete Estimate Item
Delete Estimate Item
Delete Finding Attachment
Delete Finding Attachment
Delete Gross Pay Item
Delete Gross Pay Item
Delete Invoice Item
Delete Invoice Item
Delete Job Attachment
Delete Job Attachment
Delete Journal Entry
Delete Journal Entry
Delete Location Contact
Delete Location Contact
Delete Location Note
Delete Location Note
Delete Non Job Appointment
Delete Non Job Appointment
Delete Payroll Adjustment
Delete Payroll Adjustment
SERVICETITAN_DELETE_PAYROLL_ADJUSTMENTDelete a payroll adjustment in ServiceTitan by its id. employee_type is required and must match the adjustment’s owner; the spec documents no way to restore it.Input Parameters
Output
Delete Pricebook Category
Delete Pricebook Category
Delete Pricebook Discount or Fee
Delete Pricebook Discount or Fee
Delete Pricebook Equipment
Delete Pricebook Equipment
Delete Pricebook Material
Delete Pricebook Material
Delete Pricebook Service
Delete Pricebook Service
Delete Project Daily Log Attachment
Delete Project Daily Log Attachment
Delete Purchase Order Markup
Delete Purchase Order Markup
Delete Team
Delete Team
Delete Technician Shift
Delete Technician Shift
Delete Technician Skill
Delete Technician Skill
Delete Timesheet Activity
Delete Timesheet Activity
Delete Zone
Delete Zone
Detach Job Equipment
Detach Job Equipment
Detach Job from Project
Detach Job from Project
Dismiss Booking
Dismiss Booking
SERVICETITAN_DISMISS_BOOKINGDismiss a booking in ServiceTitan for a given booking provider, marking it as not converted to a job. Optionally record a call reason and a memo; no way to undo this is documented.Input Parameters
Output
Dismiss Estimate
Dismiss Estimate
SERVICETITAN_DISMISS_ESTIMATEMark an estimate as dismissed in ServiceTitan, for a quote the customer will not accept. The estimate is kept, with status Dismissed. No operation to reopen a dismissed estimate is documented; UPDATE_ESTIMATE takes a status field, but whether setting it to Open undoes a dismissal is not documented.Input Parameters
Output
Dismiss Lead
Dismiss Lead
SERVICETITAN_DISMISS_LEADDismiss a lead in ServiceTitan so it needs no further follow-up. A call reason id is required as the dismissal reason; no way to reopen a lead is documented.Input Parameters
Output
Export Appointment Assignments
Export Appointment Assignments
SERVICETITAN_EXPORT_APPOINTMENT_ASSIGNMENTSExport ServiceTitan technician-to-appointment assignments in bulk as a continuation feed. Use it for full or incremental sync; use List Appointment Assignments when you need filters.Input Parameters
Output
Export Appointments
Export Appointments
SERVICETITAN_EXPORT_APPOINTMENTSExport ServiceTitan job appointments in bulk as a continuation feed. Use it for full or incremental sync; use List Appointments when you need filters beyond active status.Input Parameters
Output
Export Bookings
Export Bookings
SERVICETITAN_EXPORT_BOOKINGSExport bookings from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch; use LIST_BOOKINGS for filtered lookups.Input Parameters
Output
Export Business Units
Export Business Units
SERVICETITAN_EXPORT_BUSINESS_UNITSExport feed of business units from ServiceTitan for bulk sync. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_BUSINESS_UNITS instead for a filtered, paged lookup.Input Parameters
Output
Export Calls
Export Calls
SERVICETITAN_EXPORT_CALLSExport feed of phone calls from ServiceTitan for bulk sync; each record carries an active flag. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_CALLS instead for a filtered, paged lookup.Input Parameters
Output
Export Customer Contacts
Export Customer Contacts
SERVICETITAN_EXPORT_CUSTOMER_CONTACTSExport customer contact entries from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch. Use LIST_CUSTOMER_CONTACTS for a filtered lookup across customers, or LIST_CUSTOMER_CONTACTS for one customer.Input Parameters
Output
Export Customers
Export Customers
SERVICETITAN_EXPORT_CUSTOMERSExport customers from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch; use LIST_CUSTOMERS for filtered lookups.Input Parameters
Output
Export Employees
Export Employees
SERVICETITAN_EXPORT_EMPLOYEESExport feed of employees from ServiceTitan for bulk sync. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_EMPLOYEES instead for a filtered, paged lookup.Input Parameters
Output
Export Equipment Systems
Export Equipment Systems
SERVICETITAN_EXPORT_EQUIPMENT_SYSTEMSExport equipment systems from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; set include_recent_changes to receive the most recent changes sooner. Use LIST_EQUIPMENT_SYSTEMS instead for a filtered, paged lookup.Input Parameters
Output
Export Estimates
Export Estimates
SERVICETITAN_EXPORT_ESTIMATESExport estimates from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from on the next call; has_more false means the feed is caught up. Use LIST_ESTIMATES for filtered lookups.Input Parameters
Output
Export Gross Pay Items
Export Gross Pay Items
SERVICETITAN_EXPORT_GROSS_PAY_ITEMSExport gross pay items from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_GROSS_PAY_ITEMS instead for a filtered lookup.Input Parameters
Output
Export Installed Equipment
Export Installed Equipment
SERVICETITAN_EXPORT_INSTALLED_EQUIPMENTExport installed equipment records from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; set include_recent_changes to receive the most recent changes sooner. Use LIST_INSTALLED_EQUIPMENT instead for a filtered, paged lookup.Input Parameters
Output
Export Inventory Adjustments
Export Inventory Adjustments
SERVICETITAN_EXPORT_INVENTORY_ADJUSTMENTSExport inventory adjustments from ServiceTitan as a continuation feed for bulk sync, with no filters. Pass the returned continue_from token back to get the next batch; use LIST_INVENTORY_ADJUSTMENTS for a filtered lookup.Input Parameters
Output
Export Inventory Bills
Export Inventory Bills
SERVICETITAN_EXPORT_INVENTORY_BILLSExport inventory bills from ServiceTitan as a continuation feed for bulk sync: returns active, inactive and deleted records with no filters. Pass the returned continue_from on the next call; use LIST_INVENTORY_BILLS instead for a filtered lookup.Input Parameters
Output
Export Inventory Returns
Export Inventory Returns
SERVICETITAN_EXPORT_INVENTORY_RETURNSExport vendor returns from ServiceTitan inventory as a continuation feed for bulk sync, with no filters. Pass the returned continue_from token back to get the next batch. Use LIST_INVENTORY_RETURNS instead for a filtered, paged lookup.Input Parameters
Output
Export Inventory Transfers
Export Inventory Transfers
SERVICETITAN_EXPORT_INVENTORY_TRANSFERSExport inventory transfers from ServiceTitan as a continuation feed for bulk sync, with no filters. Pass the returned continue_from token back to get the next batch. Use LIST_INVENTORY_TRANSFERS instead for a filtered, paged lookup.Input Parameters
Output
Export Invoice Items
Export Invoice Items
SERVICETITAN_EXPORT_INVOICE_ITEMSExport invoice line items from ServiceTitan as a continuation feed for bulk sync: returns active, inactive and deleted records with no filters. Pass the returned continue_from on the next call and keep it to pick up later changes.Input Parameters
Output
Export Invoices
Export Invoices
SERVICETITAN_EXPORT_INVOICESExport invoices from ServiceTitan as a continuation feed for bulk sync: returns active, inactive and deleted records with no filters. Pass the returned continue_from on the next call; use LIST_INVOICES instead for a filtered lookup.Input Parameters
Output
Export Invoice Templates
Export Invoice Templates
SERVICETITAN_EXPORT_INVOICE_TEMPLATESExport feed of membership invoice templates from ServiceTitan for bulk sync; the only way to enumerate templates without knowing their ids. The feed takes no filters and each record carries an active flag; pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_INVOICE_TEMPLATES or GET_INVOICE_TEMPLATE when the template ids are already known.Input Parameters
Output
Export Job Canceled Logs
Export Job Canceled Logs
SERVICETITAN_EXPORT_JOB_CANCELED_LOGSExport ServiceTitan job canceled logs (who canceled which job, when, and why) in bulk as a continuation feed. For the canceled logs of one job use LIST_JOB_CANCELED_LOGS.Input Parameters
Output
Export Job History
Export Job History
SERVICETITAN_EXPORT_JOB_HISTORYExport the status history of all ServiceTitan jobs in bulk as a continuation feed. For one job use Get Job History.Input Parameters
Output
Export Job Notes
Export Job Notes
SERVICETITAN_EXPORT_JOB_NOTESExport notes from all ServiceTitan jobs in bulk as a continuation feed. For the notes of one job use List Job Notes.Input Parameters
Output
Export Jobs
Export Jobs
SERVICETITAN_EXPORT_JOBSExport ServiceTitan jobs in bulk as a continuation feed that includes active, inactive and deleted records. Use it for full or incremental sync; use List Jobs when you need filters.Input Parameters
Output
Export Leads
Export Leads
SERVICETITAN_EXPORT_LEADSExport leads from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch; use LIST_LEADS for filtered lookups.Input Parameters
Output
Export Location Contacts
Export Location Contacts
SERVICETITAN_EXPORT_LOCATION_CONTACTSExport location contact entries from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch. Use LIST_LOCATION_CONTACTS for a filtered lookup across locations, or LIST_LOCATION_CONTACTS for one location.Input Parameters
Output
Export Locations
Export Locations
SERVICETITAN_EXPORT_LOCATIONSExport locations from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch; use LIST_LOCATIONS for filtered lookups.Input Parameters
Output
Export Memberships
Export Memberships
SERVICETITAN_EXPORT_MEMBERSHIPSExport feed of customer memberships from ServiceTitan for bulk sync; the feed takes no filters and each record carries an active flag and a status. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_MEMBERSHIPS instead for a filtered, paged lookup.Input Parameters
Output
Export Membership Status Changes
Export Membership Status Changes
SERVICETITAN_EXPORT_MEMBERSHIP_STATUS_CHANGESExport feed of customer membership status changes from ServiceTitan, across all memberships; each record gives the old and new status. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. For the history of one membership use LIST_MEMBERSHIP_STATUS_CHANGES.Input Parameters
Output
Export Membership Types
Export Membership Types
SERVICETITAN_EXPORT_MEMBERSHIP_TYPESExport feed of membership types from ServiceTitan for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_MEMBERSHIP_TYPES instead for a filtered, paged lookup.Input Parameters
Output
Export Payments
Export Payments
SERVICETITAN_EXPORT_PAYMENTSExport customer payments from ServiceTitan as a continuation feed for bulk sync: returns active, inactive and deleted records with no filters. Pass the returned continue_from on the next call; use LIST_PAYMENTS instead for a filtered lookup.Input Parameters
Output
Export Payroll Activity Codes
Export Payroll Activity Codes
SERVICETITAN_EXPORT_PAYROLL_ACTIVITY_CODESExport payroll activity codes (earning codes) from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_ACTIVITY_CODES instead for a filtered lookup.Input Parameters
Output
Export Payroll Adjustments
Export Payroll Adjustments
SERVICETITAN_EXPORT_PAYROLL_ADJUSTMENTSExport payroll adjustments from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_ADJUSTMENTS instead for a filtered lookup.Input Parameters
Output
Export Payroll Job Splits
Export Payroll Job Splits
SERVICETITAN_EXPORT_PAYROLL_JOB_SPLITSExport payroll job splits (each technician’s split of a job) from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_JOB_SPLITS instead for a filtered lookup.Input Parameters
Output
Export Payroll Job Timesheets
Export Payroll Job Timesheets
SERVICETITAN_EXPORT_PAYROLL_JOB_TIMESHEETSExport job timesheets (technician dispatch, arrival and completion times on job appointments) from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_JOB_TIMESHEETS instead for a filtered lookup.Input Parameters
Output
Export Payroll Settings
Export Payroll Settings
SERVICETITAN_EXPORT_PAYROLL_SETTINGSExport employee and technician payroll settings from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_SETTINGS instead for a filtered lookup.Input Parameters
Output
Export Pricebook Categories
Export Pricebook Categories
SERVICETITAN_EXPORT_PRICEBOOK_CATEGORIESExport pricebook categories from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; records appear about 15 minutes after a change unless include_recent_changes is true. Use LIST_PRICEBOOK_CATEGORIES instead for a filtered, paged lookup.Input Parameters
Output
Export Pricebook Equipment
Export Pricebook Equipment
SERVICETITAN_EXPORT_PRICEBOOK_EQUIPMENTExport pricebook equipment items from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; records appear about 15 minutes after a change unless include_recent_changes is true. Use LIST_PRICEBOOK_EQUIPMENT instead for a filtered, paged lookup.Input Parameters
Output
Export Pricebook Materials
Export Pricebook Materials
SERVICETITAN_EXPORT_PRICEBOOK_MATERIALSExport pricebook materials from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; records appear about 15 minutes after a change unless include_recent_changes is true. Use LIST_PRICEBOOK_MATERIALS instead for a filtered, paged lookup.Input Parameters
Output
Export Pricebook Services
Export Pricebook Services
SERVICETITAN_EXPORT_PRICEBOOK_SERVICESExport pricebook services from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; records appear about 15 minutes after a change unless include_recent_changes is true. Use LIST_PRICEBOOK_SERVICES instead for a filtered, paged lookup.Input Parameters
Output
Export Project Notes
Export Project Notes
SERVICETITAN_EXPORT_PROJECT_NOTESExport notes from all ServiceTitan projects in bulk as a continuation feed. For the notes of one project use List Project Notes.Input Parameters
Output
Export Projects
Export Projects
SERVICETITAN_EXPORT_PROJECTSExport ServiceTitan projects in bulk as a continuation feed that includes active, inactive and deleted records. Use it for full or incremental sync; use List Projects when you need filters.Input Parameters
Output
Export Purchase Orders
Export Purchase Orders
SERVICETITAN_EXPORT_PURCHASE_ORDERSExport purchase orders from ServiceTitan as a continuation feed for bulk sync; use LIST_PURCHASE_ORDERS when you need filters. Pass the returned continue_from token back to get the next batch.Input Parameters
Output
Export Receipts
Export Receipts
SERVICETITAN_EXPORT_RECEIPTSExport inventory receipts from ServiceTitan as a continuation feed for bulk sync. Pass continue_from from each response to get the next batch. Use LIST_INVENTORY_RECEIPTS for filtered, paged lookup.Input Parameters
Output
Export Recurring Service Events
Export Recurring Service Events
SERVICETITAN_EXPORT_RECURRING_SERVICE_EVENTSExport feed of recurring service events from ServiceTitan for bulk sync; the feed takes no filters, and an event with active false has been deleted. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_RECURRING_SERVICE_EVENTS instead for a filtered, paged lookup.Input Parameters
Output
Export Recurring Services
Export Recurring Services
SERVICETITAN_EXPORT_RECURRING_SERVICESExport feed of location recurring services from ServiceTitan for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_RECURRING_SERVICES instead for a filtered, paged lookup.Input Parameters
Output
Export Recurring Service Types
Export Recurring Service Types
SERVICETITAN_EXPORT_RECURRING_SERVICE_TYPESExport feed of recurring service types from ServiceTitan for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_RECURRING_SERVICE_TYPES instead for a filtered, paged lookup.Input Parameters
Output
Export Service Agreements
Export Service Agreements
SERVICETITAN_EXPORT_SERVICE_AGREEMENTSExport feed of service agreements from ServiceTitan for bulk sync. Returns active, inactive and deleted records; pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_SERVICE_AGREEMENTS instead for a filtered, paged lookup.Input Parameters
Output
Export Tag Types
Export Tag Types
SERVICETITAN_EXPORT_TAG_TYPESExport feed of tag types from ServiceTitan for bulk sync. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_TAG_TYPES instead for a filtered, paged lookup.Input Parameters
Output
Export Technician Ratings
Export Technician Ratings
SERVICETITAN_EXPORT_TECHNICIAN_RATINGSExport technician ratings from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch. Use LIST_TECHNICIAN_RATINGS instead for a filtered, paged lookup.Input Parameters
Output
Export Technicians
Export Technicians
SERVICETITAN_EXPORT_TECHNICIANSExport feed of technicians from ServiceTitan for bulk sync. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_TECHNICIANS instead for a filtered, paged lookup.Input Parameters
Output
Export Timesheet Activities
Export Timesheet Activities
SERVICETITAN_EXPORT_TIMESHEET_ACTIVITIESExport timesheet activities from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_TIMESHEET_ACTIVITIES instead for a filtered lookup.Input Parameters
Output
Export Timesheet Activity Categories
Export Timesheet Activity Categories
SERVICETITAN_EXPORT_TIMESHEET_ACTIVITY_CATEGORIESExport timesheet activity categories from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_TIMESHEET_ACTIVITY_CATEGORIES instead for a filtered lookup.Input Parameters
Output
Export Timesheet Activity Types
Export Timesheet Activity Types
SERVICETITAN_EXPORT_TIMESHEET_ACTIVITY_TYPESExport timesheet activity types from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_TIMESHEET_ACTIVITY_TYPES instead for a filtered lookup.Input Parameters
Output
Export Timesheet Codes
Export Timesheet Codes
SERVICETITAN_EXPORT_TIMESHEET_CODESExport timesheet codes from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_TIMESHEET_CODES instead for a filtered lookup.Input Parameters
Output
Get AP Bill
Get AP Bill
Get Appointment
Get Appointment
Get Arrival Window
Get Arrival Window
Get Arrival Window Configuration
Get Arrival Window Configuration
Get Booking
Get Booking
Get Booking Provider Tag
Get Booking Provider Tag
Get Business Hours
Get Business Hours
Get Business Unit
Get Business Unit
Get Call
Get Call
Get Call Recording
Get Call Recording
Get Call Voicemail
Get Call Voicemail
Get Campaign
Get Campaign
Get Campaign Category
Get Campaign Category
Get Campaign Cost
Get Campaign Cost
Get Campaign Cost Summary
Get Campaign Cost Summary
Get Cancel Reasons by Job IDs
Get Cancel Reasons by Job IDs
Get Capacity
Get Capacity
SERVICETITAN_GET_CAPACITYCalculate real-time ServiceTitan capacity and technician availability for a time frame, optionally for given business units and a job type. Read-only even though it is a POST; use it before booking a job to find open slots.Input Parameters
Output
Get Contact
Get Contact
Get Contact Method
Get Contact Method
Get Contact Method Preference
Get Contact Method Preference
Get Customer
Get Customer
Get Email Channel Cost
Get Email Channel Cost
Get Employee
Get Employee
Get Employee Payroll Settings
Get Employee Payroll Settings
Get Equipment System
Get Equipment System
Get Equipment Type
Get Equipment Type
Get Estimate
Get Estimate
Get Estimate Template
Get Estimate Template
Get Expense Transaction
Get Expense Transaction
Get Finding Attachment
Get Finding Attachment
Get GL Account
Get GL Account
Get Hold Reasons by Job IDs
Get Hold Reasons by Job IDs
Get Installed Equipment
Get Installed Equipment
Get Invoice Template
Get Invoice Template
Get Job
Get Job
Get Job Booked Log
Get Job Booked Log
Get Job Equipment
Get Job Equipment
SERVICETITAN_GET_JOB_EQUIPMENTGet the IDs of the equipment items attached to one ServiceTitan job. Returns IDs only. The spec does not say which equipment ids these are; they are not the equipment system ids of the equipment-system tools, and whether installed-equipment ids (LIST_INSTALLED_EQUIPMENT) or pricebook equipment ids (LIST_PRICEBOOK_EQUIPMENT) are meant is unverified.Input Parameters
Output
Get Job History
Get Job History
Get Job Type
Get Job Type
Get Journal Entry
Get Journal Entry
Get Labor Type
Get Labor Type
Get Lead
Get Lead
Get Location
Get Location
Get Location Preferred Technician
Get Location Preferred Technician
Get Membership
Get Membership
Get Membership Type
Get Membership Type
SERVICETITAN_GET_MEMBERSHIP_TYPEGet one membership type in ServiceTitan by its id. The spec gives this operation no include flags and does not say whether duration_billing, discounts, recurring_services and tag_type_ids are filled; null means not loaded. LIST_MEMBERSHIP_TYPES with ids and the include_ flags returns them.Input Parameters
Output
Get Non Job Appointment
Get Non Job Appointment
Get Payment Term
Get Payment Term
Get Payment Type
Get Payment Type
Get Payroll Activity Code
Get Payroll Activity Code
Get Payroll Adjustment
Get Payroll Adjustment
Get Pricebook Category
Get Pricebook Category
Get Pricebook Discount or Fee
Get Pricebook Discount or Fee
Get Pricebook Equipment
Get Pricebook Equipment
Get Pricebook Material
Get Pricebook Material
Get Pricebook Material Markup
Get Pricebook Material Markup
Get Pricebook Service
Get Pricebook Service
SERVICETITAN_GET_PRICEBOOK_SERVICEGet one service from the ServiceTitan pricebook by id, including its linked materials and equipment.Input Parameters
Output
Get Project
Get Project
Get Project Daily Log
Get Project Daily Log
Get Project Status
Get Project Status
Get Project Sub Status
Get Project Sub Status
Get Project Type
Get Project Type
Get Proposal Template
Get Proposal Template
Get Provider Booking
Get Provider Booking
SERVICETITAN_GET_PROVIDER_BOOKINGGet one booking in ServiceTitan that belongs to a given booking provider. Works only when the connection was granted the booking provider tag passed as booking_provider_id.Input Parameters
Output
Get Purchase Order
Get Purchase Order
Get Purchase Order Markup
Get Purchase Order Markup
Get Recurring Service
Get Recurring Service
Get Recurring Service Type
Get Recurring Service Type
Get Remittance Vendor
Get Remittance Vendor
Get Report
Get Report
Get Report Data
Get Report Data
SERVICETITAN_GET_REPORT_DATARun a report in ServiceTitan and return one page of rows with the column headers. Rate limit: 1 call of the same report per minute per tenant, so ask for a large page_size (up to 25000) rather than many small pages; for slow reports use START_REPORT_DATA_QUERY and poll GET_REPORT_DATA_QUERY_RESULT.Input Parameters
Output
Get Report Data Query Result
Get Report Data Query Result
Get Router Performance
Get Router Performance
SERVICETITAN_GET_ROUTER_PERFORMANCEGet performance counts for one Scheduling Pro router in ServiceTitan over a time window: total sessions opened and interacted with, and opened sessions split by scheduler. Both window bounds are required.Input Parameters
Output
Get Scheduler Performance
Get Scheduler Performance
SERVICETITAN_GET_SCHEDULER_PERFORMANCEGet performance metrics for one Scheduling Pro scheduler in ServiceTitan over a time window, such as sessions, completion rates and jobs booked. Both window bounds are required.Input Parameters
Output
Get Service Agreement
Get Service Agreement
Get Task
Get Task
Get Task Reference Data
Get Task Reference Data
Get Team
Get Team
Get Technician
Get Technician
Get Technician Payroll Settings
Get Technician Payroll Settings
Get Technician Shift
Get Technician Shift
Get Technician Skill
Get Technician Skill
Get Technician Tracking URL
Get Technician Tracking URL
Get Timesheet Activity
Get Timesheet Activity
Get Timesheet Activity Category
Get Timesheet Activity Category
Get Timesheet Activity Type
Get Timesheet Activity Type
Get Timesheet Code
Get Timesheet Code
Get Vendor
Get Vendor
SERVICETITAN_GET_VENDORGet one ServiceTitan inventory vendor by id, including contact details, tax rate, and delivery option.Input Parameters
Output
Get Well Known GL Accounts
Get Well Known GL Accounts
Get Zone
Get Zone
Hold Appointment
Hold Appointment
Import Sms Opt Ins
Import Sms Opt Ins
SERVICETITAN_IMPORT_SMS_OPT_INSImport SMS marketing opt-ins into ServiceTitan for phone numbers whose consent was collected externally. Send only numbers whose owners agreed to receive text messages; check the returned successful, invalid and unsuccessful numbers for individual outcomes.Input Parameters
Output
List Ad Performance
List Ad Performance
List AP Bill Custom Field Types
List AP Bill Custom Field Types
SERVICETITAN_LIST_AP_BILL_CUSTOM_FIELD_TYPESList the custom field type definitions available for AP bills in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_AP_BILL_CUSTOM_FIELDS.Input Parameters
Output
List AP Bills
List AP Bills
SERVICETITAN_LIST_AP_BILLSList accounts-payable (vendor) bills in ServiceTitan with their line items, one page per call. Filter by bill number, status, sync status, source, cost or dates; bill_type defaults to Procurement, so pass ApBill to see standalone AP bills.Input Parameters
Output
List AP Credit Custom Field Types
List AP Credit Custom Field Types
SERVICETITAN_LIST_AP_CREDIT_CUSTOM_FIELD_TYPESList the custom field type definitions available for AP credits in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_AP_CREDIT_CUSTOM_FIELDS.Input Parameters
Output
List AP Credits
List AP Credits
SERVICETITAN_LIST_AP_CREDITSList accounts-payable credits (vendor credits) in ServiceTitan, one page per call. Filter by ids, sync status, or created or modified dates.Input Parameters
Output
List AP Payment Custom Field Types
List AP Payment Custom Field Types
SERVICETITAN_LIST_AP_PAYMENT_CUSTOM_FIELD_TYPESList the custom field type definitions available for AP payments in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_AP_PAYMENT_CUSTOM_FIELDS.Input Parameters
Output
List AP Payments
List AP Payments
SERVICETITAN_LIST_AP_PAYMENTSList accounts-payable payments (payments made to vendors) in ServiceTitan, one page per call. These are outgoing vendor payments; use LIST_PAYMENTS for payments received from customers.Input Parameters
Output
List Appointment Assignments
List Appointment Assignments
SERVICETITAN_LIST_APPOINTMENT_ASSIGNMENTSList technician-to-appointment assignments in ServiceTitan, one page per call, filtered by appointment, job, technician or appointment start range. Use it to see who is assigned to an appointment.Input Parameters
Output
List Appointments
List Appointments
SERVICETITAN_LIST_APPOINTMENTSList ServiceTitan job appointments, one page per call, filtered by job, project, technician, customer, status or start/modified date ranges. Use this to find all appointments of a job or project.Input Parameters
Output
List Arrival Windows
List Arrival Windows
SERVICETITAN_LIST_ARRIVAL_WINDOWSList the arrival windows configured in ServiceTitan, one page per call. An arrival window is a time range, per business unit, offered to customers when booking.Input Parameters
Output
List Attributed Leads
List Attributed Leads
List Bank Deposits
List Bank Deposits
SERVICETITAN_LIST_BANK_DEPOSITSList bank deposits in ServiceTitan, one page per call. Filter by deposit date, review status, deposit status, sync status or gross amount.Input Parameters
Output
List Bank Deposit Transactions
List Bank Deposit Transactions
List Booking Contacts
List Booking Contacts
SERVICETITAN_LIST_BOOKING_CONTACTSList the contact entries (phone, email, fax) on one booking in ServiceTitan, one page per call. This is the tenant-wide path; it needs a connection with no booking provider restriction. Use LIST_PROVIDER_BOOKING_CONTACTS when the connection is restricted to a single booking provider tag.Input Parameters
Output
List Bookings
List Bookings
SERVICETITAN_LIST_BOOKINGSList bookings in ServiceTitan across all booking providers, one page per call. Use LIST_PROVIDER_BOOKINGS when the connection is restricted to a single booking provider tag.Input Parameters
Output
List Budget Codes
List Budget Codes
List Budget Code Segment Item Children
List Budget Code Segment Item Children
List Budget Code Segment Items
List Budget Code Segment Items
List Budget Code Segments
List Budget Code Segments
SERVICETITAN_LIST_BUDGET_CODE_SEGMENTSList company-level budget code segments of the ServiceTitan work breakdown structure. Results can be requested by page; the response contains segment data without a continuation flag.Input Parameters
Output
List Business Units
List Business Units
SERVICETITAN_LIST_BUSINESS_UNITSList business units in ServiceTitan, the divisions of the company that revenue and work are tracked and reported under. Returns one page per call.Input Parameters
Output
List Call Reasons
List Call Reasons
SERVICETITAN_LIST_CALL_REASONSList call reasons in ServiceTitan, one page per call. Use it to find the reason id needed to dismiss a lead or booking or to create a lead.Input Parameters
Output
List Calls
List Calls
SERVICETITAN_LIST_CALLSList one page of inbound and outbound phone calls recorded in ServiceTitan, with filters including campaign, agent, phone number, minimum duration, tag and created or modified time.Input Parameters
Output
List Campaign Categories
List Campaign Categories
SERVICETITAN_LIST_CAMPAIGN_CATEGORIESList marketing campaign categories in ServiceTitan, one page per call. Categories group campaigns; they are not pricebook categories.Input Parameters
Output
List Campaign Costs
List Campaign Costs
List Campaign Costs For Campaign
List Campaign Costs For Campaign
List Campaigns
List Campaigns
SERVICETITAN_LIST_CAMPAIGNSList marketing campaigns in ServiceTitan, one page per call, filtered by name, tracking phone number, ids or dates. Only active campaigns are returned unless active is set to False or Any.Input Parameters
Output
List Capacity Warnings
List Capacity Warnings
List Client Specific Pricing Rate Sheets
List Client Specific Pricing Rate Sheets
SERVICETITAN_LIST_CLIENT_SPECIFIC_PRICING_RATE_SHEETSList client-specific pricing rate sheets in the ServiceTitan pricebook, each with its per-SKU price exceptions. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Contact Method Preferences
List Contact Method Preferences
List Contact Methods
List Contact Methods
SERVICETITAN_LIST_CONTACT_METHODSList contact methods across ServiceTitan contacts, one page per call. Pass contact_id for one contact, or filter across contacts by value, type, reference id, or date.Input Parameters
Output
List Contact Preference Types
List Contact Preference Types
List Contact Relationships
List Contact Relationships
SERVICETITAN_LIST_CONTACT_RELATIONSHIPSList the customers, locations and bookings a contact is linked to in ServiceTitan, one page per call.Input Parameters
Output
List Contacts
List Contacts
SERVICETITAN_LIST_CONTACTSList contacts (person records with name and title) in ServiceTitan, one page per call. These are the GUID-keyed contacts; for the phone and email entries on a customer use LIST_CUSTOMER_CONTACTS.Input Parameters
Output
List Contacts For Relationship
List Contacts For Relationship
SERVICETITAN_LIST_CONTACTS_FOR_RELATIONSHIPList the contacts in ServiceTitan attached to one relationship id, one page per call. Relationship ids come from LIST_CONTACT_RELATIONSHIPS.Input Parameters
Output
List Credit Memo Custom Field Types
List Credit Memo Custom Field Types
SERVICETITAN_LIST_CREDIT_MEMO_CUSTOM_FIELD_TYPESList the custom field type definitions available for credit memos in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_CREDIT_MEMO_CUSTOM_FIELDS.Input Parameters
Output
List Credit Memo Items
List Credit Memo Items
SERVICETITAN_LIST_CREDIT_MEMO_ITEMSList credit memo line items across credit memos in ServiceTitan, one page per call. Pass credit_memo_ids with one ID for a single credit memo or a provider-formatted multi-ID string for several; without it, items of every credit memo are returned.Input Parameters
Output
List Credit Memos
List Credit Memos
SERVICETITAN_LIST_CREDIT_MEMOSList customer credit memos in ServiceTitan, one page per call. Filter by applied invoices, dates, status, batch, business unit, total, balance or custom fields.Input Parameters
Output
List Customer Contacts
List Customer Contacts
SERVICETITAN_LIST_CUSTOMER_CONTACTSList contact entries for one or more ServiceTitan customers, or by modified-date range, one page per call. Pass one customer ID for the single-customer case. A location’s contacts are separate records; use LIST_LOCATION_CONTACTS for them.Input Parameters
Output
List Customer Custom Field Types
List Customer Custom Field Types
SERVICETITAN_LIST_CUSTOMER_CUSTOM_FIELD_TYPESList the custom field types defined for customers in ServiceTitan, one page per call. Use it to find the type_id needed when setting custom_fields on a customer.Input Parameters
Output
List Customer Notes
List Customer Notes
SERVICETITAN_LIST_CUSTOMER_NOTESList the notes on one customer in ServiceTitan, one page per call.Input Parameters
Output
List Customers
List Customers
SERVICETITAN_LIST_CUSTOMERSList customers in ServiceTitan, one page per call, filtered by name, address, phone, ids or dates. Only active customers are returned unless active is set to False or Any.Input Parameters
Output
List Dynamic Value Set Values
List Dynamic Value Set Values
List Employee Payrolls
List Employee Payrolls
SERVICETITAN_LIST_EMPLOYEE_PAYROLLSList the payrolls (pay period records) of one office employee in ServiceTitan, one page per call. Use LIST_TECHNICIAN_PAYROLLS for a technician.Input Parameters
Output
List Employees
List Employees
SERVICETITAN_LIST_EMPLOYEESList employees in ServiceTitan, the office staff such as CSRs, dispatchers and bookkeepers, filtered by name, email or user id. Field technicians are a separate resource.Input Parameters
Output
List Equipment Systems
List Equipment Systems
SERVICETITAN_LIST_EQUIPMENT_SYSTEMSList equipment systems in ServiceTitan, the named groups of installed equipment at a customer location (for example one HVAC system), filtered by location or date range. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Equipment Types
List Equipment Types
SERVICETITAN_LIST_EQUIPMENT_TYPESList the equipment types defined in ServiceTitan for classifying installed equipment, filtered by name or date range. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Estimate Items
List Estimate Items
SERVICETITAN_LIST_ESTIMATE_ITEMSList estimate line items in ServiceTitan across estimates, or for one estimate when estimate_id is given. Returns one page per call.Input Parameters
Output
List Estimates
List Estimates
SERVICETITAN_LIST_ESTIMATESList estimates in ServiceTitan, filtered by job, project, location, seller, status, total amount, or sold/created/modified time. Returns one page per call.Input Parameters
Output
List Estimate Status Changes
List Estimate Status Changes
List Estimate Templates
List Estimate Templates
SERVICETITAN_LIST_ESTIMATE_TEMPLATESList estimate templates in ServiceTitan, the reusable sets of pricebook items that estimates and proposal templates are built from. Returns one page per call.Input Parameters
Output
List Expense Transaction Custom Field Types
List Expense Transaction Custom Field Types
SERVICETITAN_LIST_EXPENSE_TRANSACTION_CUSTOM_FIELD_TYPESList the custom field type definitions available for expense transactions in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_EXPENSE_TRANSACTION_CUSTOM_FIELDS.Input Parameters
Output
List Expense Transactions
List Expense Transactions
SERVICETITAN_LIST_EXPENSE_TRANSACTIONSList expense transactions, such as card expenses, in ServiceTitan, one page per call. Filter by number, vendor name, employee, status, source system, cost or transaction date; NotSet is not an accepted expense status filter.Input Parameters
Output
List Finding Attachments
List Finding Attachments
SERVICETITAN_LIST_FINDING_ATTACHMENTSList the attachments of one ServiceTitan finding, by finding id. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Findings
List Findings
SERVICETITAN_LIST_FINDINGSList findings in ServiceTitan, the issues or observations recorded at customer locations, filtered by location, installed equipment, source job, or date range. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Forms
List Forms
SERVICETITAN_LIST_FORMSList form definitions in ServiceTitan, filtered by name, published status, or whether they have conditional logic or triggers. Returns the forms themselves, not what people filled in.Input Parameters
Output
List Form Submissions
List Form Submissions
SERVICETITAN_LIST_FORM_SUBMISSIONSList filled-in form submissions in ServiceTitan with their answers, filtered by form, status, submitter, submission time, or the record the form is attached to (job, customer, location and so on).Input Parameters
Output
List GL Accounts
List GL Accounts
SERVICETITAN_LIST_GL_ACCOUNTSList general ledger (GL) accounts in ServiceTitan, one page per call. Filter by ids, names, numbers, types, subtypes, description text, source or active status; only active accounts are returned unless active is set.Input Parameters
Output
List GL Account Types
List GL Account Types
SERVICETITAN_LIST_GL_ACCOUNT_TYPESList general ledger account types in ServiceTitan, one page per call. Use it to find the type names accepted when creating or filtering GL accounts.Input Parameters
Output
List Gross Pay Items
List Gross Pay Items
SERVICETITAN_LIST_GROSS_PAY_ITEMSList gross pay items (earnings such as timesheet time, bonuses, salary and reimbursements) in ServiceTitan, one page per call. Filter by employee, payroll or date to get the earnings of a pay period. These are computed earnings, not the raw clock times in LIST_PAYROLL_JOB_TIMESHEETS or LIST_NON_JOB_TIMESHEETS.Input Parameters
Output
List Installed Equipment
List Installed Equipment
SERVICETITAN_LIST_INSTALLED_EQUIPMENTList equipment installed at ServiceTitan customer locations, filtered by location, equipment system, parent, or date range. For catalog equipment in the pricebook use LIST_PRICEBOOK_EQUIPMENT. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Installed Equipment Custom Field Types
List Installed Equipment Custom Field Types
SERVICETITAN_LIST_INSTALLED_EQUIPMENT_CUSTOM_FIELD_TYPESList the custom field types defined for ServiceTitan installed equipment, with each type’s data type and options. The descending flag is required. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Intacct Business Unit Mappings
List Intacct Business Unit Mappings
SERVICETITAN_LIST_INTACCT_BUSINESS_UNIT_MAPPINGSList how ServiceTitan business units map to Sage Intacct locations, departments and classes. Only useful for tenants with the Intacct accounting integration; page, page_size and include_total are all required here.Input Parameters
Output
List Inventory Adjustments
List Inventory Adjustments
SERVICETITAN_LIST_INVENTORY_ADJUSTMENTSList inventory adjustments in ServiceTitan, filtered by type, inventory location, business unit, invoice, batch, sync status, or date range. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Inventory Bill Custom Field Types
List Inventory Bill Custom Field Types
SERVICETITAN_LIST_INVENTORY_BILL_CUSTOM_FIELD_TYPESList the custom field type definitions available for inventory bills in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_INVENTORY_BILL_CUSTOM_FIELDS.Input Parameters
Output
List Inventory Bills
List Inventory Bills
SERVICETITAN_LIST_INVENTORY_BILLSList inventory bills (vendor bills created from purchase orders and receipts) in ServiceTitan, one page per call. Filter by bill number, purchase order, job number, sync status, cost or dates; bills are read-only apart from custom fields and the exported mark.Input Parameters
Output
List Inventory Receipts
List Inventory Receipts
SERVICETITAN_LIST_INVENTORY_RECEIPTSList inventory receipts in ServiceTitan, the records of items received against purchase orders, filtered by purchase order, vendor, bill, inventory location, or received date. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Inventory Returns
List Inventory Returns
SERVICETITAN_LIST_INVENTORY_RETURNSList vendor returns in ServiceTitan inventory, filtered by vendor, purchase order, job, inventory location, business unit, or return date. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Inventory Return Types
List Inventory Return Types
SERVICETITAN_LIST_INVENTORY_RETURN_TYPESList vendor return types in ServiceTitan inventory; a return type id is required to create a return. The active_only flag is required. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Inventory Templates
List Inventory Templates
SERVICETITAN_LIST_INVENTORY_TEMPLATESList ServiceTitan inventory templates with their items, each item carrying a minimum and maximum quantity. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Inventory Transfers
List Inventory Transfers
SERVICETITAN_LIST_INVENTORY_TRANSFERSList inventory transfers in ServiceTitan, the movements of stock between inventory locations, filtered by status, source or destination location, transfer type, job, or date. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Invoice Custom Field Types
List Invoice Custom Field Types
SERVICETITAN_LIST_INVOICE_CUSTOM_FIELD_TYPESList the custom field type definitions available for invoices in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_INVOICE_CUSTOM_FIELDS.Input Parameters
Output
List Invoices
List Invoices
SERVICETITAN_LIST_INVOICESList customer invoices in ServiceTitan, one page per call; every invoice type (job, membership, project, point of sale, adjustment) comes from this one tool. Invoices of every status are returned unless statuses is set; the spec does not document which active state applies when active_state is left out.Input Parameters
Output
List Invoice Tasks
List Invoice Tasks
SERVICETITAN_LIST_INVOICE_TASKSList the workflow tasks attached to one invoice in ServiceTitan, one page per call. These are invoice tasks created from templates, not Task Management tasks.Input Parameters
Output
List Invoice Templates
List Invoice Templates
SERVICETITAN_LIST_INVOICE_TEMPLATESLook up membership invoice templates in ServiceTitan by id (ids is required, max 50). It cannot enumerate all templates: to browse every template use EXPORT_INVOICE_TEMPLATES; otherwise take ids from a customer membership’s billing template or a recurring service’s invoice template.Input Parameters
Output
List Job Attachments
List Job Attachments
SERVICETITAN_LIST_JOB_ATTACHMENTSList files attached to a specified ServiceTitan job, with optional creation-date filters, sorting, and pagination. OAuth access requires the tn.frm.jobs:r scope.Input Parameters
Output
List Job Canceled Logs
List Job Canceled Logs
List Job Cancel Reasons
List Job Cancel Reasons
SERVICETITAN_LIST_JOB_CANCEL_REASONSList the cancel reasons configured in ServiceTitan, one page per call. Use it to pick the reason_id for Cancel Job; it does not say why a given job was canceled.Input Parameters
Output
List Job Custom Field Types
List Job Custom Field Types
SERVICETITAN_LIST_JOB_CUSTOM_FIELD_TYPESList the custom field types available for ServiceTitan jobs, one page per call. Use the returned IDs as type_id in the custom_fields of Create Job or Update Job.Input Parameters
Output
List Job Hold Reasons
List Job Hold Reasons
SERVICETITAN_LIST_JOB_HOLD_REASONSList the hold reasons configured in ServiceTitan, one page per call. Use it to pick the reason_id for Hold Appointment; it does not say why a given job is on hold.Input Parameters
Output
List Job Notes
List Job Notes
List Jobs
List Jobs
SERVICETITAN_LIST_JOBSList ServiceTitan jobs, one page per call, filtered by status, customer, location, project, technician, job type or date ranges for creation, modification, completion and appointments.Input Parameters
Output
List Job Types
List Job Types
SERVICETITAN_LIST_JOB_TYPESList ServiceTitan job types, one page per call, filtered by name, priority, duration or dates. Use it to find the job_type_id for Create Job.Input Parameters
Output
List Journal Entries
List Journal Entries
SERVICETITAN_LIST_JOURNAL_ENTRIESList journal entries in ServiceTitan, one page per call (page_size max 500). Filter by posting, transaction or export dates, number range, status, sync status, transaction type, names, business units or reference numbers or custom fields.Input Parameters
Output
List Journal Entry Details
List Journal Entry Details
List Journal Entry Summary
List Journal Entry Summary
List Labor Types
List Labor Types
SERVICETITAN_LIST_LABOR_TYPESList payroll labor types in ServiceTitan, one page per call. A labor type classifies paid time and can map to a labor service in the pricebook.Input Parameters
Output
List Lead Notes
List Lead Notes
SERVICETITAN_LIST_LEAD_NOTESList the notes on one lead in ServiceTitan, one page per call.Input Parameters
Output
List Leads
List Leads
SERVICETITAN_LIST_LEADSList leads in ServiceTitan, one page per call, filtered by status, customer, dates or the name and phone given on the lead. Use status Open to find leads that still need follow-up.Input Parameters
Output
List Location Contacts
List Location Contacts
SERVICETITAN_LIST_LOCATION_CONTACTSList contact entries for one or more ServiceTitan locations, or by created or modified date range, one page per call. Pass one location ID for the single-location case. A customer’s contacts are separate records; use LIST_CUSTOMER_CONTACTS for them.Input Parameters
Output
List Location Custom Field Types
List Location Custom Field Types
SERVICETITAN_LIST_LOCATION_CUSTOM_FIELD_TYPESList the custom field types defined for locations in ServiceTitan, one page per call. Use it to find the type_id needed when setting custom_fields on a location.Input Parameters
Output
List Location Labor Rates
List Location Labor Rates
SERVICETITAN_LIST_LOCATION_LABOR_RATESList the hourly labor rates set per customer location and labor type in ServiceTitan, one page per call. Pass location_ids to limit the result to specific locations.Input Parameters
Output
List Location Notes
List Location Notes
SERVICETITAN_LIST_LOCATION_NOTESList the notes on one location in ServiceTitan, one page per call.Input Parameters
Output
List Locations
List Locations
SERVICETITAN_LIST_LOCATIONSList locations in ServiceTitan, one page per call, filtered by customer, name, address, ids or dates. Only active locations are returned unless active is set to False or Any.Input Parameters
List Membership Custom Field Types
List Membership Custom Field Types
SERVICETITAN_LIST_MEMBERSHIP_CUSTOM_FIELD_TYPESList the custom field types defined for customer memberships in ServiceTitan. Returns field definitions (id, name, data type), not the values stored on a membership.Input Parameters
Output
List Memberships
List Memberships
SERVICETITAN_LIST_MEMBERSHIPSList customer memberships in ServiceTitan, filtered by customer, status, duration, billing frequency or created/modified time. A customer membership is one customer’s instance of a membership type; use the membership types tools for the templates themselves.Input Parameters
Output
List Membership Status Changes
List Membership Status Changes
List Membership Type Discounts
List Membership Type Discounts
List Membership Type Duration Billing Items
List Membership Type Duration Billing Items
SERVICETITAN_LIST_MEMBERSHIP_TYPE_DURATION_BILLING_ITEMSList the duration and billing options of one membership type in ServiceTitan, with their prices. Each option’s id is the duration_billing_id needed to sell a membership. Not paged.Input Parameters
Output
List Membership Type Recurring Service Items
List Membership Type Recurring Service Items
List Membership Types
List Membership Types
SERVICETITAN_LIST_MEMBERSHIP_TYPESList membership types in ServiceTitan, the templates that memberships are sold from. Discounts, duration/billing options, recurring services and tags are left out unless the matching include_ flag is true.Input Parameters
Output
List Non Job Appointments
List Non Job Appointments
SERVICETITAN_LIST_NON_JOB_APPOINTMENTSList ServiceTitan non-job appointments (technician time blocked for non-customer activities), one page per call, filtered by technician, start range or timesheet code. For customer job visits use List Appointments.Input Parameters
Output
List Non Job Timesheets
List Non Job Timesheets
SERVICETITAN_LIST_NON_JOB_TIMESHEETSList non-job timesheets (time recorded against timesheet codes) in ServiceTitan, one page per call. Filter by employee_id, employee_type, dates or active status. Covers time not on a job; for dispatch-to-done time on job appointments use LIST_PAYROLL_JOB_TIMESHEETS.Input Parameters
Output
List Opt Outs
List Opt Outs
List Payment Custom Field Types
List Payment Custom Field Types
SERVICETITAN_LIST_PAYMENT_CUSTOM_FIELD_TYPESList the custom field type definitions available for payments in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_PAYMENT_CUSTOM_FIELDS.Input Parameters
Output
List Payments
List Payments
SERVICETITAN_LIST_PAYMENTSList payments received from customers in ServiceTitan, one page per call. Filter by the invoices they were applied to, customer, deposit, paid date, status or total; use LIST_AP_PAYMENTS for payments made to vendors.Input Parameters
Output
List Payment Terms
List Payment Terms
SERVICETITAN_LIST_PAYMENT_TERMSList payment terms (the due-date rules attached to invoices and bills) in ServiceTitan, one page per call. Payment terms are read-only through the API.Input Parameters
Output
List Payment Types
List Payment Types
SERVICETITAN_LIST_PAYMENT_TYPESList payment types (for example cash, check, credit card) in ServiceTitan, one page per call. Use it to find the type_id needed by UPDATE_PAYMENT.Input Parameters
Output
List Payroll Activity Codes
List Payroll Activity Codes
SERVICETITAN_LIST_PAYROLL_ACTIVITY_CODESList payroll activity codes (earning codes that map earnings to a payroll processor’s codes) in ServiceTitan, one page per call. These are not timesheet activities; use LIST_TIMESHEET_ACTIVITIES for recorded time.Input Parameters
Output
List Payroll Adjustments
List Payroll Adjustments
SERVICETITAN_LIST_PAYROLL_ADJUSTMENTSList payroll adjustments (manually entered earnings or deductions) in ServiceTitan, one page per call. Filter by employee ids or posted date.Input Parameters
Output
List Payroll Job Splits
List Payroll Job Splits
SERVICETITAN_LIST_PAYROLL_JOB_SPLITSList payroll job splits across jobs in ServiceTitan, one page per call: one record per technician and job with that technician’s split. Pass job_ids with one ID for a single job or a provider-formatted multi-ID string for several jobs.Input Parameters
Output
List Payroll Job Timesheets
List Payroll Job Timesheets
SERVICETITAN_LIST_PAYROLL_JOB_TIMESHEETSList technician job timesheets across jobs in ServiceTitan (dispatch, arrive, cancel and done times), one page per call. job_ids limits the result to given jobs, but its format is not documented; use LIST_PAYROLL_JOB_TIMESHEETS_FOR_JOB for one job. Covers time on job appointments only; time on non-job codes (meetings, training) is in LIST_NON_JOB_TIMESHEETS, and paid earnings are in LIST_GROSS_PAY_ITEMS.Input Parameters
Output
List Payroll Job Timesheets for Job
List Payroll Job Timesheets for Job
SERVICETITAN_LIST_PAYROLL_JOB_TIMESHEETS_FOR_JOBList the technician timesheets recorded on one job in ServiceTitan (dispatch, arrive, cancel and done times), one page per call. Use LIST_PAYROLL_JOB_TIMESHEETS to read across jobs.Input Parameters
Output
List Payrolls
List Payrolls
SERVICETITAN_LIST_PAYROLLSList payrolls (one employee’s or technician’s pay period record) across all staff in ServiceTitan, one page per call. Filter by employee type, period dates, approval date or status.Input Parameters
Output
List Payroll Settings
List Payroll Settings
SERVICETITAN_LIST_PAYROLL_SETTINGSList the payroll settings (hourly rate, hire date, manager, external payroll id) of employees and technicians in ServiceTitan, one page per call. Filter by employee type or active status.Input Parameters
Output
List Pricebook Categories
List Pricebook Categories
SERVICETITAN_LIST_PRICEBOOK_CATEGORIESList pricebook categories in ServiceTitan, optionally only Services or Materials categories. Each category carries its nested subcategories. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Pricebook Discounts and Fees
List Pricebook Discounts and Fees
SERVICETITAN_LIST_PRICEBOOK_DISCOUNTS_AND_FEESList discounts and fees in the ServiceTitan pricebook, with optional search text and category filters. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Pricebook Equipment
List Pricebook Equipment
SERVICETITAN_LIST_PRICEBOOK_EQUIPMENTList equipment items in the ServiceTitan pricebook (sellable catalog entries such as furnaces), with optional search text and category filters. For equipment installed at a customer location use LIST_INSTALLED_EQUIPMENT. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Pricebook Material Cost Types
List Pricebook Material Cost Types
List Pricebook Material Markups
List Pricebook Material Markups
SERVICETITAN_LIST_PRICEBOOK_MATERIAL_MARKUPSList the material markup tiers in the ServiceTitan pricebook, each a from/to range with the markup percent applied to it. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Pricebook Materials
List Pricebook Materials
SERVICETITAN_LIST_PRICEBOOK_MATERIALSList materials in the ServiceTitan pricebook, with optional search text, category, and cost type filters. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Pricebook Services
List Pricebook Services
SERVICETITAN_LIST_PRICEBOOK_SERVICESList services in the ServiceTitan pricebook, with optional search text and category filters. Set calculate_prices to apply current dynamic pricing rules. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Project Budget Codes
List Project Budget Codes
List Project Budget Code Segment Item Children
List Project Budget Code Segment Item Children
List Project Budget Code Segment Items
List Project Budget Code Segment Items
List Project Budget Code Segments
List Project Budget Code Segments
SERVICETITAN_LIST_PROJECT_BUDGET_CODE_SEGMENTSList budget code segments of one ServiceTitan project’s work breakdown structure. Results can be requested by page; the response does not include a has_more flag.Input Parameters
Output
List Project Custom Field Types
List Project Custom Field Types
SERVICETITAN_LIST_PROJECT_CUSTOM_FIELD_TYPESList the custom field types available for ServiceTitan projects, one page per call. Use the returned IDs as type_id in the custom_fields of Create Project or Update Project.Input Parameters
Output
List Project Daily Logs
List Project Daily Logs
List Project Notes
List Project Notes
List Projects
List Projects
SERVICETITAN_LIST_PROJECTSList ServiceTitan projects, one page per call, filtered by customer, location, status, job, technician, manager or date ranges. Use job_id to find the project a job belongs to.Input Parameters
Output
List Project Statuses
List Project Statuses
SERVICETITAN_LIST_PROJECT_STATUSESList the project statuses configured in ServiceTitan, one page per call. Use the IDs as status_id on a project.Input Parameters
Output
List Project Sub Statuses
List Project Sub Statuses
SERVICETITAN_LIST_PROJECT_SUB_STATUSESList the project sub statuses configured in ServiceTitan, one page per call, optionally for one parent status.Input Parameters
Output
List Project Types
List Project Types
List Proposal Templates
List Proposal Templates
SERVICETITAN_LIST_PROPOSAL_TEMPLATESList proposal templates in ServiceTitan, which map the options of a proposal type to estimate templates, one page per call.Input Parameters
Output
List Proposal Types
List Proposal Types
SERVICETITAN_LIST_PROPOSAL_TYPESList proposal types in ServiceTitan with their options. Use it to get the proposal_type_id and proposal_type_option_id values that proposal templates need. Not paged.Input Parameters
Output
List Provider Booking Contacts
List Provider Booking Contacts
SERVICETITAN_LIST_PROVIDER_BOOKING_CONTACTSList the contact entries on one booking in ServiceTitan that belongs to a given booking provider, one page per call. Works only when the connection was granted the booking provider tag passed as booking_provider_id. Use LIST_BOOKING_CONTACTS when the connection has no booking provider restriction.Input Parameters
Output
List Provider Bookings
List Provider Bookings
SERVICETITAN_LIST_PROVIDER_BOOKINGSList the bookings in ServiceTitan that belong to one booking provider, one page per call. Works only when the connection was granted the booking provider tag passed as booking_provider_id.Input Parameters
Output
List Purchase Order Markups
List Purchase Order Markups
SERVICETITAN_LIST_PURCHASE_ORDER_MARKUPSList the purchase order markup tiers in ServiceTitan, each a from/to range with the markup percent applied to it. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Purchase Order Requests
List Purchase Order Requests
SERVICETITAN_LIST_PURCHASE_ORDER_REQUESTSList purchase order requests in ServiceTitan, filtered by request status, number, job, project, technician, or date range. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Purchase Orders
List Purchase Orders
SERVICETITAN_LIST_PURCHASE_ORDERSList purchase orders in ServiceTitan, filtered by status, number, job, project, technician, inventory location, or date range. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Purchase Order Types
List Purchase Order Types
SERVICETITAN_LIST_PURCHASE_ORDER_TYPESList purchase order types in ServiceTitan; a type id is required to create a purchase order. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Recurring Service Events
List Recurring Service Events
SERVICETITAN_LIST_RECURRING_SERVICE_EVENTSList recurring service events in ServiceTitan, the visits generated from a location’s recurring services, filtered by location, job, follow-up status or created/modified time.Input Parameters
Output
List Recurring Services
List Recurring Services
SERVICETITAN_LIST_RECURRING_SERVICESList location recurring services in ServiceTitan (a recurring service type applied to one location), filtered by membership, location or created/modified time. Technician ids are left out unless include_technicians is true.Input Parameters
Output
List Recurring Service Types
List Recurring Service Types
SERVICETITAN_LIST_RECURRING_SERVICE_TYPESList recurring service types in ServiceTitan, the templates that location recurring services are created from, filtered by membership type, recurrence type or duration type.Input Parameters
Output
List Remittance Vendors
List Remittance Vendors
SERVICETITAN_LIST_REMITTANCE_VENDORSList remittance vendors (the pay-to parties for vendor payments) in ServiceTitan, one page per call. These are not the inventory vendors that purchase orders are placed with.Input Parameters
Output
List Report Categories
List Report Categories
List Reports
List Reports
List Reviews
List Reviews
SERVICETITAN_LIST_REVIEWSList customer reviews collected by ServiceTitan Marketing Reputation, one page per call, filtered by date, rating, source, technician, campaign or location. Several filters take numeric codes whose meanings the spec does not document.Input Parameters
Output
List Router Sessions
List Router Sessions
SERVICETITAN_LIST_ROUTER_SESSIONSList the customer booking sessions that went through one Scheduling Pro router in ServiceTitan, with outcome, customer details and any job or booking created.Input Parameters
Output
List Schedulers
List Schedulers
SERVICETITAN_LIST_SCHEDULERSList the online booking schedulers set up in ServiceTitan Scheduling Pro, with their status and default flag. Each record also carries data_api_key, the scheduler’s web-install key; it is sensitive, so do not repeat it to the user unless asked.Input Parameters
Output
List Scheduler Sessions
List Scheduler Sessions
SERVICETITAN_LIST_SCHEDULER_SESSIONSList the customer booking sessions of one Scheduling Pro scheduler in ServiceTitan, with customer details, outcome and any job or booking created.Input Parameters
Output
List Service Agreement Custom Field Types
List Service Agreement Custom Field Types
SERVICETITAN_LIST_SERVICE_AGREEMENT_CUSTOM_FIELD_TYPESList the custom field types defined for service agreements in ServiceTitan. Returns field definitions, not the values stored on an agreement.Input Parameters
Output
List Service Agreements
List Service Agreements
SERVICETITAN_LIST_SERVICE_AGREEMENTSList service agreements in ServiceTitan, the maintenance contracts for commercial customers, filtered by customer, business unit, status or created/modified time. Read-only: the API has no way to create or change an agreement.Input Parameters
Output
List Tag Types
List Tag Types
SERVICETITAN_LIST_TAG_TYPESList tag types in ServiceTitan, the labels that can be put on customers, jobs, locations and other records. The tag type ids are what other tools take as tag_type_ids.Input Parameters
Output
List Tasks
List Tasks
SERVICETITAN_LIST_TASKSList office tasks in ServiceTitan Task Management, one page per call, filtered by status, priority, assignee, customer, job, project or dates. Set include_subtasks to true to also return each task’s subtasks. These are Task Management tasks, not the invoice workflow tasks of CREATE_INVOICE_TASK / LIST_INVOICE_TASKS.Input Parameters
Output
List Tax Zones
List Tax Zones
SERVICETITAN_LIST_TAX_ZONESList tax zones and their tax rates in ServiceTitan, one page per call. With no active-status filter, the default is active tax zones.Input Parameters
Output
List Teams
List Teams
SERVICETITAN_LIST_TEAMSList ServiceTitan dispatch teams, one page per call. Inactive teams are left out unless include_inactive is true.Input Parameters
Output
List Technician Payrolls
List Technician Payrolls
SERVICETITAN_LIST_TECHNICIAN_PAYROLLSList the payrolls (pay period records) of one technician in ServiceTitan, one page per call. Use LIST_EMPLOYEE_PAYROLLS for an office employee.Input Parameters
Output
List Technician Ratings
List Technician Ratings
SERVICETITAN_LIST_TECHNICIAN_RATINGSList technician ratings in ServiceTitan, one page per call, filtered by technician, job or dates. Each rating is tied to one technician and one job.Input Parameters
Output
List Technicians
List Technicians
SERVICETITAN_LIST_TECHNICIANSList technicians in ServiceTitan, the field staff who work jobs, filtered by name or user id. Office employees are a separate resource.Input Parameters
Output
List Technician Shifts
List Technician Shifts
SERVICETITAN_LIST_TECHNICIAN_SHIFTSList ServiceTitan technician shifts, one page per call, filtered by technician, shift type (Normal, OnCall, TimeOff), time range, or text in the title or note.Input Parameters
Output
List Technician Skills
List Technician Skills
SERVICETITAN_LIST_TECHNICIAN_SKILLSList ServiceTitan technician skills, one page per call, optionally for one technician. Each entry is one skill held by one technician.Input Parameters
Output
List Timesheet Activities
List Timesheet Activities
SERVICETITAN_LIST_TIMESHEET_ACTIVITIESList timesheet activities (blocks of time recorded against an activity type, from the Timesheets API) in ServiceTitan, one page per call. It filters only by job, project, active status and created or modified dates, not by employee or work date; for job dispatch/arrive/done times use LIST_PAYROLL_JOB_TIMESHEETS, for time booked to payroll timesheet codes use LIST_NON_JOB_TIMESHEETS, and for paid earnings use LIST_GROSS_PAY_ITEMS.Input Parameters
Output
List Timesheet Activity Categories
List Timesheet Activity Categories
SERVICETITAN_LIST_TIMESHEET_ACTIVITY_CATEGORIESList timesheet activity categories, the groups that activity types belong to, in ServiceTitan, one page per call.Input Parameters
Output
List Timesheet Activity Types
List Timesheet Activity Types
SERVICETITAN_LIST_TIMESHEET_ACTIVITY_TYPESList timesheet activity types in ServiceTitan, one page per call. Use it to find the activity_type_id needed to create a timesheet activity.Input Parameters
Output
List Timesheet Codes
List Timesheet Codes
SERVICETITAN_LIST_TIMESHEET_CODESList timesheet codes in ServiceTitan, one page per call. Each code says which employee type it applies to and whether it is unpaid, paid, clock in/out or paid time off. Codes are the categories used by LIST_NON_JOB_TIMESHEETS; they are not payroll activity codes (LIST_PAYROLL_ACTIVITY_CODES).Input Parameters
Output
List Trucks
List Trucks
SERVICETITAN_LIST_TRUCKSList trucks in ServiceTitan inventory, the vehicle inventory locations assigned to technicians. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List User Roles
List User Roles
SERVICETITAN_LIST_USER_ROLESList user roles in ServiceTitan, the permission sets assigned to employees and technicians. Use it to get the role_id needed to create an employee or technician.Input Parameters
Output
List Vehicle Events
List Vehicle Events
SERVICETITAN_LIST_VEHICLE_EVENTSList historical driving events for FleetPro vehicles in ServiceTitan, by VIN and time window. Only data older than 7 days is available, the window may span at most 24 hours, at most 50 VINs per call, and results are capped at 10,000 records.Input Parameters
Output
List Vehicle GPS Records
List Vehicle GPS Records
SERVICETITAN_LIST_VEHICLE_GPS_RECORDSList historical GPS positions for FleetPro vehicles in ServiceTitan, by VIN and time window. Only data older than 7 days is available, the window may span at most 24 hours, at most 50 VINs per call, and results are capped at 10,000 records.Input Parameters
Output
List Vehicles
List Vehicles
List Vendor Custom Field Types
List Vendor Custom Field Types
SERVICETITAN_LIST_VENDOR_CUSTOM_FIELD_TYPESList the custom field types defined for ServiceTitan vendors, with each type’s data type and options. Use it to find valid custom field names before writing vendor custom fields. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Vendors
List Vendors
SERVICETITAN_LIST_VENDORSList inventory vendors (suppliers) in ServiceTitan, filtered by name, ids, active status, external data, or date range. Returns one page per call; request the next page while has_more is true. For the pay-to parties of vendor payments use LIST_REMITTANCE_VENDORS.Input Parameters
Output
List Warehouses
List Warehouses
SERVICETITAN_LIST_WAREHOUSESList warehouses in ServiceTitan inventory; warehouse ids are used as inventory locations on purchase orders, returns, and trucks. Returns one page per call; request the next page while has_more is true.Input Parameters
Output
List Zones
List Zones
SERVICETITAN_LIST_ZONESList ServiceTitan dispatch zones, one page per call. A zone groups zip codes, cities or territories and the business units and technicians that serve them.Input Parameters
Output
Lookup Opt Outs
Lookup Opt Outs
SERVICETITAN_LOOKUP_OPT_OUTSCheck the opt-out status of specific phone numbers in ServiceTitan. Numbers with no opt-out are left out of the result, and the whole request fails if any number cannot be parsed.Input Parameters
Output
Mark AP Bills as Exported
Mark AP Bills as Exported
SERVICETITAN_MARK_AP_BILLS_AS_EXPORTEDMark one or more AP bills as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.Input Parameters
Output
Mark AP Credits as Exported
Mark AP Credits as Exported
SERVICETITAN_MARK_AP_CREDITS_AS_EXPORTEDMark one or more AP credits as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.Input Parameters
Output
Mark AP Payments as Exported
Mark AP Payments as Exported
SERVICETITAN_MARK_AP_PAYMENTS_AS_EXPORTEDMark one or more AP payments as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.Input Parameters
Output
Mark Bank Deposits as Exported
Mark Bank Deposits as Exported
SERVICETITAN_MARK_BANK_DEPOSITS_AS_EXPORTEDMark one or more bank deposits as exported to an external accounting system in ServiceTitan. Unlike the other mark-as-exported tools, the documented response has no body, so there is no per-id result to check. ServiceTitan documents no operation to undo the exported mark.Input Parameters
Output
Mark Credit Memos as Exported
Mark Credit Memos as Exported
SERVICETITAN_MARK_CREDIT_MEMOS_AS_EXPORTEDMark one or more credit memos as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.Input Parameters
Output
Mark Expense Transactions as Exported
Mark Expense Transactions as Exported
SERVICETITAN_MARK_EXPENSE_TRANSACTIONS_AS_EXPORTEDMark one or more expense transactions as exported in ServiceTitan. Only an expense in the Posted state moves to Exported; an id that is missing or not Posted comes back as a failure row while the call itself still succeeds. ServiceTitan documents no operation to undo a successful exported mark.Input Parameters
Output
Mark Inventory Bills as Exported
Mark Inventory Bills as Exported
SERVICETITAN_MARK_INVENTORY_BILLS_AS_EXPORTEDMark one or more inventory bills as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. ServiceTitan documents no operation to undo a successful exported mark.Input Parameters
Output
Mark Invoices as Exported
Mark Invoices as Exported
SERVICETITAN_MARK_INVOICES_AS_EXPORTEDMark one or more invoices as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.Input Parameters
Output
Mark Recurring Service Event Complete
Mark Recurring Service Event Complete
Mark Recurring Service Event Incomplete
Mark Recurring Service Event Incomplete
Match Budget Codes
Match Budget Codes
Match Project Budget Codes
Match Project Budget Codes
Reject Purchase Order Request
Reject Purchase Order Request
SERVICETITAN_REJECT_PURCHASE_ORDER_REQUESTReject a ServiceTitan purchase order request by its request id, with a required rejection reason. Takes the request id from LIST_PURCHASE_ORDER_REQUESTS, not a purchase order id. No way to withdraw a rejection is documented.Input Parameters
Output
Remove Appointment Confirmation
Remove Appointment Confirmation
Remove Appointment Hold
Remove Appointment Hold
Remove Customer Tag
Remove Customer Tag
Remove Equipment from Equipment System
Remove Equipment from Equipment System
SERVICETITAN_REMOVE_EQUIPMENT_FROM_EQUIPMENT_SYSTEMDetach installed equipment from a ServiceTitan equipment system, by system id and a list of installed equipment ids. The equipment records themselves are not deleted.Input Parameters
Output
Remove Job Cancellation
Remove Job Cancellation
Remove Location Tag
Remove Location Tag
Replace Contact
Replace Contact
Replace Contact Method
Replace Contact Method
Replace Journal Entry
Replace Journal Entry
Reschedule Appointment
Reschedule Appointment
SERVICETITAN_RESCHEDULE_APPOINTMENTMove a ServiceTitan job appointment to a new start and end time, and optionally a new arrival window. It changes only the schedule, not the assigned technicians.Input Parameters
Output
Sell Estimate
Sell Estimate
Send Employee Account Invite
Send Employee Account Invite
Send Employee Password Reset Link
Send Employee Password Reset Link
Send Technician Account Invite
Send Technician Account Invite
Send Technician Password Reset Link
Send Technician Password Reset Link
Set Appointment Summary
Set Appointment Summary
SERVICETITAN_SET_APPOINTMENT_SUMMARYSet the work-performed summary for one technician on a ServiceTitan job appointment. Private preview: available to specific accounts only, so expect an error on tenants without it.Input Parameters
Output
Set Arrival Window Active
Set Arrival Window Active
Set Business Unit External Data
Set Business Unit External Data
SERVICETITAN_SET_BUSINESS_UNIT_EXTERNAL_DATAAttach external data (key/value pairs owned by an application GUID) to a business unit in ServiceTitan. It cannot change the unit’s name, address or other settings.Input Parameters
Output
Start Report Data Query
Start Report Data Query
SERVICETITAN_START_REPORT_DATA_QUERYStart a long-running report data query in ServiceTitan. If it finishes within about 10 seconds the rows come back directly; otherwise it returns a status and a query_token to poll for the result. Rate limit: 1 call of the same report per minute per tenant. Use GET_REPORT_DATA for fast reports that return within one call.Input Parameters
Output
Submit Lead Form
Submit Lead Form
Unassign Technicians from Appointment
Unassign Technicians from Appointment
Unsell Estimate
Unsell Estimate
Update AP Bill Custom Fields
Update AP Bill Custom Fields
Update AP Credit Custom Fields
Update AP Credit Custom Fields
Update AP Payment Custom Fields
Update AP Payment Custom Fields
Update Appointment Special Instructions
Update Appointment Special Instructions
Update Arrival Window
Update Arrival Window
SERVICETITAN_UPDATE_ARRIVAL_WINDOWReplace the start time, duration and business units of a ServiceTitan arrival window. All three fields are required. To turn a window on or off use Set Arrival Window Active.Input Parameters
Output
Update Arrival Window Configuration
Update Arrival Window Configuration
SERVICETITAN_UPDATE_ARRIVAL_WINDOW_CONFIGURATIONChange the tenant-wide ServiceTitan arrival window setting that decides whether a job’s default start time is the start or the end of the chosen arrival window. Affects all future bookings.Input Parameters
Output
Update Booking
Update Booking
SERVICETITAN_UPDATE_BOOKINGUpdate fields of an existing booking in ServiceTitan for a given booking provider. Only the fields sent are changed; if address is sent, all six of its fields are required.Input Parameters
Output
Update Booking Contact
Update Booking Contact
SERVICETITAN_UPDATE_BOOKING_CONTACTUpdate one contact entry on a booking in ServiceTitan for a given booking provider. Only the fields sent are changed.Input Parameters
Output
Update Booking Provider Tag
Update Booking Provider Tag
Update Call
Update Call
SERVICETITAN_UPDATE_CALLUpdate a call record in ServiceTitan: its call type, reason, excuse memo, tag and linked customer, location, job, campaign or agent. This is a PUT and excuse_memo, reason, customer, location and tag are required on every call; GET_CALL does not return the current location, excuse memo or tag, so have those values ready before calling.Input Parameters
Output
Update Campaign
Update Campaign
SERVICETITAN_UPDATE_CAMPAIGNUpdate a marketing campaign in ServiceTitan. The spec requires name, business_unit_id, category_id and active on every call, so read the campaign first and send its current values for fields you are not changing.Input Parameters
Output
Update Campaign Category
Update Campaign Category
Update Campaign Cost
Update Campaign Cost
Update Client Specific Pricing Rate Sheet
Update Client Specific Pricing Rate Sheet
SERVICETITAN_UPDATE_CLIENT_SPECIFIC_PRICING_RATE_SHEETUpdate the per-SKU price exceptions of a client-specific pricing rate sheet in the ServiceTitan pricebook, by rate sheet id. The spec does not say whether the exceptions sent replace the sheet’s current list or are merged into it.Input Parameters
Output
Update Contact
Update Contact
Update Contact Method
Update Contact Method
SERVICETITAN_UPDATE_CONTACT_METHODUpdate the value or memo of a contact method in ServiceTitan. Only the fields sent are changed; the type cannot be changed here. Use REPLACE_CONTACT_METHOD to overwrite every field, including type. contact_id is the GUID of a person contact from CREATE_CONTACT or LIST_CONTACTS; to add a phone or email directly to a customer, location or booking use CREATE_CUSTOMER_CONTACT, CREATE_LOCATION_CONTACT or CREATE_BOOKING_CONTACT.Input Parameters
Output
Update Contact Method Preference
Update Contact Method Preference
SERVICETITAN_UPDATE_CONTACT_METHOD_PREFERENCESet the value of one communication preference on a contact method in ServiceTitan. The value is sent as a string whatever the preference’s data type.Input Parameters
Output
Update Credit Memo
Update Credit Memo
Update Credit Memo Custom Fields
Update Credit Memo Custom Fields
SERVICETITAN_UPDATE_CREDIT_MEMO_CUSTOM_FIELDSSet custom field values on one or more credit memos in ServiceTitan. Each operation names one credit memo id and the fields to set; a field name must already exist as a custom field type, and the documented response has no body.Input Parameters
Output
Update Customer
Update Customer
SERVICETITAN_UPDATE_CUSTOMERUpdate fields of a customer in ServiceTitan. Only the fields sent are changed, but custom_fields and tag_type_ids are treated as full lists: send every value you want to keep. To add or remove one tag, use ADD_CUSTOMER_TAG or REMOVE_CUSTOMER_TAG.Input Parameters
Output
Update Customer Contact
Update Customer Contact
SERVICETITAN_UPDATE_CUSTOMER_CONTACTUpdate one contact entry on a customer in ServiceTitan. Only the fields sent are changed; if preferences is sent, all five of its flags are required. This is the customer’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.Input Parameters
Output
Update Employee
Update Employee
SERVICETITAN_UPDATE_EMPLOYEEUpdate an office employee in ServiceTitan; only the fields sent are changed. business_unit_access_ids is a full replacement, and account_locked sets whether the account is locked.Input Parameters
Output
Update Employee Payroll Settings
Update Employee Payroll Settings
Update Equipment System
Update Equipment System
SERVICETITAN_UPDATE_EQUIPMENT_SYSTEMUpdate a ServiceTitan equipment system by id. Omitted fields are left unchanged; equipment_ids, when sent, replaces the system’s whole equipment list (use ADD_EQUIPMENT_TO_EQUIPMENT_SYSTEM or REMOVE_EQUIPMENT_FROM_EQUIPMENT_SYSTEM to change one item), and an empty list for tags or custom fields clears them.Input Parameters
Output
Update Equipment Type
Update Equipment Type
Update Estimate
Update Estimate
SERVICETITAN_UPDATE_ESTIMATEUpdate an estimate in ServiceTitan. This is a PUT with every field optional; whether omitted fields and items are kept or cleared is not documented, so read the estimate first and send the full intended values.Input Parameters
Output
Update Estimate Template
Update Estimate Template
SERVICETITAN_UPDATE_ESTIMATE_TEMPLATEUpdate an estimate template in ServiceTitan; only the fields sent are changed. Sending items replaces every item on the template, and summary and business_unit_id cannot be cleared once set.Input Parameters
Output
Update Expense Transaction Custom Fields
Update Expense Transaction Custom Fields
SERVICETITAN_UPDATE_EXPENSE_TRANSACTION_CUSTOM_FIELDSSet custom field values on one or more expense transactions in ServiceTitan. The request is all-or-nothing: an unknown custom field name or expense id returns 422 and no update is saved.Input Parameters
Output
Update Finding
Update Finding
Update Finding Attachment
Update Finding Attachment
SERVICETITAN_UPDATE_FINDING_ATTACHMENTUpdate the file name, URL, or media type of an attachment on a ServiceTitan finding. Supply at least one field to change.Input Parameters
Output
Update GL Account
Update GL Account
Update Gross Pay Item
Update Gross Pay Item
SERVICETITAN_UPDATE_GROSS_PAY_ITEMUpdate a gross pay item in ServiceTitan and return its id. This is a PUT: payroll_id, amount, activity_code_id and date are required on every call, and the spec does not say whether optional fields left out are kept or cleared.Input Parameters
Output
Update Installed Equipment
Update Installed Equipment
SERVICETITAN_UPDATE_INSTALLED_EQUIPMENTUpdate fields of a ServiceTitan installed equipment record by id. Send only the fields to change; the spec marks none of them required. List fields such as custom_fields and tag_type_ids are sent as the lists you give.Input Parameters
Output
Update Inventory Adjustment
Update Inventory Adjustment
SERVICETITAN_UPDATE_INVENTORY_ADJUSTMENTUpdate fields of an existing ServiceTitan inventory adjustment by id. Only the fields you send are changed, but items is sent as the full list: lines left out of it are removed.Input Parameters
Output
Update Inventory Adjustment Custom Fields
Update Inventory Adjustment Custom Fields
SERVICETITAN_UPDATE_INVENTORY_ADJUSTMENT_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan inventory adjustments in a single request. Each operation names the adjustment by objectId and the custom fields to write; the documented response has no body.Input Parameters
Output
Update Inventory Bill Custom Fields
Update Inventory Bill Custom Fields
SERVICETITAN_UPDATE_INVENTORY_BILL_CUSTOM_FIELDSSet custom field values on one or more inventory bills in ServiceTitan. Each operation names one inventory bill id and the fields to set; a field name must already exist as a custom field type, and the documented response has no body.Input Parameters
Output
Update Inventory Receipt Custom Fields
Update Inventory Receipt Custom Fields
SERVICETITAN_UPDATE_INVENTORY_RECEIPT_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan inventory receipts in a single request. Each operation names the receipt by objectId and the custom fields to write; the documented response has no body.Input Parameters
Output
Update Inventory Return
Update Inventory Return
SERVICETITAN_UPDATE_INVENTORY_RETURNUpdate fields of an existing ServiceTitan vendor return by id. Only the fields you send are changed.Input Parameters
Output
Update Inventory Return Custom Fields
Update Inventory Return Custom Fields
SERVICETITAN_UPDATE_INVENTORY_RETURN_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan inventory returns in a single request. Each operation names the return by objectId and the custom fields to write; the documented response has no body.Input Parameters
Output
Update Inventory Return Type
Update Inventory Return Type
SERVICETITAN_UPDATE_INVENTORY_RETURN_TYPEUpdate a ServiceTitan vendor return type by id. Only the fields you send are changed.Input Parameters
Output
Update Inventory Transfer
Update Inventory Transfer
SERVICETITAN_UPDATE_INVENTORY_TRANSFERUpdate an existing ServiceTitan inventory transfer by id. The source location, transfer type, and date can only be changed while the transfer is Pending.Input Parameters
Output
Update Inventory Transfer Custom Fields
Update Inventory Transfer Custom Fields
SERVICETITAN_UPDATE_INVENTORY_TRANSFER_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan inventory transfers in a single request. Each operation names the transfer by objectId and the custom fields to write.Input Parameters
Output
Update Invoice
Update Invoice
SERVICETITAN_UPDATE_INVOICEUpdate an invoice’s header fields, line items or payment settlement status in ServiceTitan; only the fields sent are changed. Each entry in items needs description and quantity, and the documented response has no body, so read the invoice back with LIST_INVOICES to confirm.Input Parameters
Output
Update Invoice Custom Fields
Update Invoice Custom Fields
Update Invoice Item
Update Invoice Item
SERVICETITAN_UPDATE_INVOICE_ITEMUpdate one line item on an invoice in ServiceTitan; item_id names the item to change, and description and quantity are required on every call.Input Parameters
Output
Update Invoice Task
Update Invoice Task
SERVICETITAN_UPDATE_INVOICE_TASKUpdate the name, status, assignee, due date or description of a task on an invoice in ServiceTitan; only the fields sent are changed. task_id is a string id from LIST_INVOICE_TASKS. This is an invoice workflow task, not a Task Management task (CREATE_TASK).Input Parameters
Output
Update Invoice Template
Update Invoice Template
SERVICETITAN_UPDATE_INVOICE_TEMPLATEUpdate a membership invoice template in ServiceTitan; only the top-level fields sent are changed. Whether items replaces or merges with the existing items is not documented, so read the template first and send the full intended item list.Input Parameters
Output
Update Job
Update Job
SERVICETITAN_UPDATE_JOBUpdate fields of a ServiceTitan job; only the fields sent are changed, and job status cannot be changed here. custom_fields and tag_type_ids replace the whole list, so include every value you want to keep.Input Parameters
Output
Update Job Type
Update Job Type
SERVICETITAN_UPDATE_JOB_TYPEUpdate fields of a ServiceTitan job type; only the fields sent are changed. custom_field_type_ids replaces the assigned list unless custom_fields_update_mode is Merge.Input Parameters
Output
Update Journal Entry
Update Journal Entry
SERVICETITAN_UPDATE_JOURNAL_ENTRYUpdate a journal entry’s status (Open or Closed) and custom fields in ServiceTitan. It cannot change lines or amounts; use REPLACE_JOURNAL_ENTRY for that. Custom fields not named are left as they are; a named custom field can be set to null but not deleted.Input Parameters
Output
Update Journal Entry Sync Status
Update Journal Entry Sync Status
SERVICETITAN_UPDATE_JOURNAL_ENTRY_SYNC_STATUSRecord the result of syncing a journal entry to an external accounting system in ServiceTitan by setting its sync status. version_id is required when the status is Synced and must match the entry version that was synced.Input Parameters
Output
Update Labor Type
Update Labor Type
SERVICETITAN_UPDATE_LABOR_TYPEReplace a payroll labor type in ServiceTitan. This is a full update: name, code and active are required on every call, and leaving out service_code_id clears the labor type’s service code.Input Parameters
Output
Update Lead
Update Lead
Update Location
Update Location
SERVICETITAN_UPDATE_LOCATIONUpdate fields of a location in ServiceTitan. Only the fields sent are changed, but custom_fields and tag_type_ids replace the full lists, so anything left out of them is removed.Input Parameters
Output
Update Location Contact
Update Location Contact
SERVICETITAN_UPDATE_LOCATION_CONTACTUpdate one contact entry on a location in ServiceTitan. Only the fields sent are changed; if preferences is sent, all five of its flags are required. This is the location’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.Input Parameters
Output
Update Location Preferred Technician
Update Location Preferred Technician
Update Membership
Update Membership
SERVICETITAN_UPDATE_MEMBERSHIPUpdate a customer membership in ServiceTitan; only the fields sent are changed. status takes Active, Suspended, Expired, Canceled or Deleted, and recurring_service_action None deletes the membership’s existing recurring services. Explicit null clears to_date, location_id and recurring_location_id.Input Parameters
Output
Update Non Job Appointment
Update Non Job Appointment
SERVICETITAN_UPDATE_NON_JOB_APPOINTMENTReplace a ServiceTitan non-job appointment. This is a full update: technician, start, duration and name are required every time.Input Parameters
Output
Update Payment
Update Payment
SERVICETITAN_UPDATE_PAYMENTUpdate a customer payment record in ServiceTitan: type, paid date, memo, status and how it is split across invoices. type_id and splits are required on every call even though this is a PATCH.Input Parameters
Output
Update Payment Custom Fields
Update Payment Custom Fields
Update Payment Status
Update Payment Status
SERVICETITAN_UPDATE_PAYMENT_STATUSSet the status (Pending, Posted or Exported) of one or more customer payments in ServiceTitan in one call. The documented response has no body, so read the payments back with LIST_PAYMENTS to confirm.Input Parameters
Output
Update Payroll Adjustment
Update Payroll Adjustment
SERVICETITAN_UPDATE_PAYROLL_ADJUSTMENTUpdate a payroll adjustment in ServiceTitan with a PUT. employee_id and posted_on are required on every call along with the employee_type query value; the spec does not say what happens to optional fields that are left out.Input Parameters
Output
Update Pricebook Category
Update Pricebook Category
SERVICETITAN_UPDATE_PRICEBOOK_CATEGORYUpdate fields of a ServiceTitan pricebook category by ID and return the updated category. Supply at least one body field with a non-null value, or set parent_id to null.Input Parameters
Output
Update Pricebook Discount or Fee
Update Pricebook Discount or Fee
SERVICETITAN_UPDATE_PRICEBOOK_DISCOUNT_OR_FEEUpdate fields of a discount or fee in the ServiceTitan pricebook by ID. Provide at least one non-null body field; categories and assets are sent as the lists supplied.Input Parameters
Output
Update Pricebook Equipment
Update Pricebook Equipment
SERVICETITAN_UPDATE_PRICEBOOK_EQUIPMENTUpdate fields of an equipment item in the ServiceTitan pricebook catalog by ID. Provide at least one non-null body field; list fields such as categories and assets are sent as the lists supplied.Input Parameters
Output
Update Pricebook Material
Update Pricebook Material
SERVICETITAN_UPDATE_PRICEBOOK_MATERIALUpdate fields of a material in the ServiceTitan pricebook by ID. Provide at least one non-null body field; fields left out are not sent.Input Parameters
Output
Update Pricebook Material Markup
Update Pricebook Material Markup
SERVICETITAN_UPDATE_PRICEBOOK_MATERIAL_MARKUPReplace a material markup tier in the ServiceTitan pricebook by id. This is a full replacement: range_from, range_to, and percent are all required.Input Parameters
Output
Update Pricebook Service
Update Pricebook Service
SERVICETITAN_UPDATE_PRICEBOOK_SERVICEUpdate fields of a service in the ServiceTitan pricebook by ID. Supply at least one non-null field to change.Input Parameters
Output
Update Project
Update Project
SERVICETITAN_UPDATE_PROJECTUpdate fields of a ServiceTitan project; only the fields sent are changed. Whether a list field such as job_ids or project_manager_ids replaces or adds to the current list is not documented, so send the complete list you want the project to have; to add one job prefer Attach Job To Project.Input Parameters
Output
Update Proposal Template
Update Proposal Template
SERVICETITAN_UPDATE_PROPOSAL_TEMPLATEUpdate a proposal template in ServiceTitan; only the fields sent are changed. Sending estimate_assignments or business_unit_ids replaces the whole list, and an empty list removes them all.Input Parameters
Output
Update Purchase Order
Update Purchase Order
SERVICETITAN_UPDATE_PURCHASE_ORDERUpdate fields of an existing ServiceTitan purchase order by id, supplying at least one non-null body field. When items is sent it replaces the item list: every active item left out is marked inactive.Input Parameters
Output
Update Purchase Order Custom Fields
Update Purchase Order Custom Fields
SERVICETITAN_UPDATE_PURCHASE_ORDER_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan purchase orders in a single request. Each operation names the purchase order by objectId and the custom fields to write by name.Input Parameters
Output
Update Purchase Order Markup
Update Purchase Order Markup
Update Purchase Order Type
Update Purchase Order Type
Update Recurring Service
Update Recurring Service
SERVICETITAN_UPDATE_RECURRING_SERVICEUpdate a location recurring service in ServiceTitan; only the fields sent are changed. Service events are generated from the recurrence fields, but whether a change regenerates events that already exist is not documented.Input Parameters
Output
Update Tag Type
Update Tag Type
Update Technician
Update Technician
SERVICETITAN_UPDATE_TECHNICIANUpdate a technician in ServiceTitan; only the fields sent are changed. zone_ids and project_label_ids replace the whole list, and account_locked true locks the technician’s account.Input Parameters
Output
Update Technician Payroll Settings
Update Technician Payroll Settings
SERVICETITAN_UPDATE_TECHNICIAN_PAYROLL_SETTINGSUpdate the payroll settings of one technician in ServiceTitan. hourly_rate is required on every call; the spec does not say whether other omitted fields are kept or cleared, except pay_type, which is left unchanged when omitted.Input Parameters
Output
Update Technician Shift
Update Technician Shift
Update Timesheet Activity
Update Timesheet Activity
SERVICETITAN_UPDATE_TIMESHEET_ACTIVITYReplace a timesheet activity in ServiceTitan. This is a PUT: activity_type_id, start_time, tag_type_ids and active are required on every call, the request has no employee field so the employee cannot be changed, and the spec does not say whether optional fields left out are cleared.Input Parameters
Output
Update Truck
Update Truck
SERVICETITAN_UPDATE_TRUCKUpdate a ServiceTitan truck by id: name, memo, warehouse, template, assigned technicians, or active status.Input Parameters
Output
Update Vendor
Update Vendor
SERVICETITAN_UPDATE_VENDORUpdate fields of an existing ServiceTitan inventory vendor by ID. Supply at least one body field; fields left out are not sent.Input Parameters
Output
Update Vendor Custom Fields
Update Vendor Custom Fields
Update Warehouse
Update Warehouse
SERVICETITAN_UPDATE_WAREHOUSEUpdate the external data attached to a ServiceTitan warehouse by id. External data is the only warehouse field this endpoint can change.Input Parameters
Output
Update Zone
Update Zone
SERVICETITAN_UPDATE_ZONEUpdate fields of a ServiceTitan dispatch zone; only the fields sent are changed. Whether a list field such as zips, cities or business_unit_ids replaces or adds to the current list is not documented, so send the complete list you want the zone to have.Input Parameters
Output
Upsert Estimate Item
Upsert Estimate Item
SERVICETITAN_UPSERT_ESTIMATE_ITEMAdd a line item to an estimate in ServiceTitan, or update an existing one when item_id is given. One item per call. With item_id the existing item is overwritten; whether fields left out are kept or cleared is not documented, and the add-or-update reading comes from the schema and ServiceTitan’s guide, not the spec.Input Parameters
Output
Upsert Project Daily Log
Upsert Project Daily Log
SERVICETITAN_UPSERT_PROJECT_DAILY_LOGCreate or update a ServiceTitan project daily log for one date, changing only the fields and sections sent and creating a log if none exists. When sending inputs or summaries, provide all six sections in that object.