Available ServiceTitan APIs

Tanisha Ray

Updated November 25, 2024 17:22

When you configure an export, import, or other type of flow step using the prebuilt ServiceTitan connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the ServiceTitan API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Activity codes	Get a list of payroll activity codes	X
Activity codes	Get payroll activity code specified by ID	X
Adjustments	Get a list of inventory adjustments	X
	Update an existing adjustment		X
	Update custom fields on adjustments		X
Appointment assignments	Get a list of appointment assignments	X
	Assign the list of technicians to the appointment		X
	Unassign the list of technicians from the appointment		X
Appointments	Get appointment specified by ID	X
	Delete appointment with specified ID		X
	Get a list of appointments	X
	Add a new appointment to an existing job		X
	Reschedule job appointment		X
	Put the appointment on hold		X
	Remove hold from the appointment		X
	Appointment update special instructions		X
	Add a confirmation to the specified appointment		X
	Add a confirmation to the specified appointment		X
Arrival windows	Arrival windows get list	X
	Arrival windows create		X
	Arrival windows get	X
	Arrival windows update		X
	Arrival windows activated		X
	Arrival windows get configuration	X
	Arrival windows updated configuration		X
Attributed leads	Return attributed leads data	X
Booking provider tags	Create a booking provider tag		X
	Get a list of booking provider tags	X
	Get a single booking provider tag by ID	X
	Update a booking provider tag		X
Bookings	Get a booking by ID	X
	Get a list of bookings	X
	Get a list of contacts for a booking	X
	Get a booking by ID for a booking provider	X
	Update a booking for a booking provider		X
	Get a list of bookings for a booking provider	X
	Create a booking for a booking provider		X
	Create a contact on the specified booking for a booking provider		X
	Get a list of contacts for a booking for a booking provider	X
	Update a single booking contact for a booking provider		X
	Remove a contact from a booking for a booking provider		X
Bulk tags	Add multiple tags to more than one customer		X
Bulk tags	Remove multiple tags to more than one customer		X
Business hour	Get the business hours	X
Business hour	Business hour Create		X
Business units	Get a list of business units	X
	Get a business unit by ID	X
	Update an existing business unit		X
Call reasons	Get a list of call reasons	X
Calls	Provide a feed for telecom calls	X
	Get call's details	X
	Update existing call		X
	Get recording of the call	X
	Get voicemail of the call	X
Calls (deprecated)	Get filtered calls	X
Campaign categories	Get a paginated list of campaign categories	X
	Create new campaign category		X
	Get campaign category specified by ID	X
	Update specified campaign category in "patch" mode		X
Campaign costs	Get a paginated list of campaign costs	X
	Create new campaign cost		X
	Get campaign cost specified by ID	X
	Update specified campaign cost in "patch" mode		X
Campaigns	Get a paginated list of campaigns	X
	Create new campaign		X
	Get campaign specified by ID	X
	Update specified campaign in "patch" mode		X
	Get a paginated list of campaign costs	X
Capacity	Capacity get list		X
Capacity awareness warning	Return all capacity awareness warnings	X
Categories	Get the categories in your pricebook	X
	Post to add a new category to your pricebook		X
	Get category details	X
	Edit an existing category in your pricebook		X
	Delete an existing category from your pricebook		X
Client side data	Client side data get	X
Customer memberships	Get a list of customer memberships	X
	Get customer membership specified by ID	X
	Update specified customer membership in "patch" mode		X
	Get status changes for the given customer membership	X
	Create membership sale invoice		X
Customers	Get a customer specified by ID	X
	Update a customer		X
	Get a list of customers	X
	Create a new customer		X
	Get a list of notes for a customer	X
	Create a new note		X
	Get a list of contacts for the specified customer	X
	Create a contact on the customer		X
	Remove a contact from a customer		X
	Update a contact on the customer		X
	Get a list of contacts for a specific modified on date range or by their customer IDs either customer IDs	X
Discount and fees	Get data on all of the discounts or fees in the pricebook	X
	Post to add a new discount or fee to your pricebook		X
	Get details if a discount or fees in the pricebook	X
	Edit an existing item in your pricebook		X
	Deletes a discount or fee from your pricebook		X
Dynamic value sets	List values of given dynamic set including key and display name	X
Employees	Get a list of employees	X
	Create new employee		X
	Get an employee by ID	X
	Update employee		X
	Perform standard actions with the account		X
Equipment	Get data on all of the equipment in the pricebook	X
	Post to add a new equipment to your pricebook		X
	Get details of an equipment in the pricebook	X
	Edit an existing item in your pricebook		X
	Delete an equipment from your pricebook		X
Estimates	Estimate get	X
	Estimate update		X
	Estimate get list	X
	Estimate create		X
	Estimate get items	X
	Estimate sell		X
	Estimate sell		X
	Estimate dismiss		X
	Estimate put item		X
	Estimate delete item		X
Estimates export	Provide export feed for estimates	X
Export	Provide export feed for bookings	X
	Provide export feed for customer contacts	X
	Provide export feed for locations contacts	X
	Provide export feed for customers	X
	Provide export feed for leads	X
	Provide export feed for appointments	X
	Provide export feed for appointment assignments	X
	Provide export feed for purchase orders	X
	Provide export feed for jobs	X
	Provide export feed for projects	X
	Provide export feed for appointments	X
	Provide export feed for job canceled logs	X
	Provide export feed for membership types	X
	Provide export feed for recurring service types	X
	Provide export feed for customer memberships	X
	Provide export feed for invoice templates	X
	Provide export feed for recurring services	X
	Provide export feed for recurring service events	X
	Provide export feed for job splits	X
	Provide export feed for payroll adjustments	X
	Provide export feed for job timesheets	X
	Provide export feed for activity codes	X
	Provide export feed for timesheet codes	X
	Provide export feed for gross pay items	X
	Provide export feed for service agreements	X
	Provide export feed for employees	X
	Provide export feed for technicians	X
	Provide export feed for business units	X
	Provide export feed for tag types	X
	Provide export feed for telecom calls	X
External call attributions	Attribute an external call (possibly coming from call tracking software) to a web session		X
Form	Retrieve form data	X
Form submission	Retrieve form submission data	X
GPS	Create new GPS ping		X
Gross pay items	Create new gross pay item		X
	Get a list of gross pay items	X
	Update specified gross pay item		X
	Delete specified gross pay item		X
Images	Download a specified pricebook image	X
Images	Upload a specified image to temporary storage to associate the image with a pricebook item		X
Installed equipment	Installed equipment get list	X
	Installed equipment create		X
	Installed equipment get	X
	Installed equipment update		X
	Installed equipment post attachment		X
	Installed equipment get 2	X
Invoice templates	Get a list of invoice templates by given IDs	X
	Create new invoice template		X
	Get invoice template specified by ID	X
	Update specified invoice template in "patch" mode		X
Job cancel reasons	Get a list of job cancel reasons	X
Job hold reasons	Get a list of job hold reasons	X
Job splits	Get a list of job splits	X
Job splits	Get a list of job splits by multiple jobs	X
Job types	Get a list of job types	X
	Create a job type		X
	Get a job type by ID	X
	Update a job type		X
Jobs	Create an attachment on the specified job		X
	Get attachments on the specified job	X
	Download a specified job attachment	X
	Get a job by ID	X
	Update a job		X
	Create a job		X
	Get a list of jobs	X
	Cancel a job		X
	Remove cancellation from a job		X
	Put a job on hold		X
	Complete a job		X
	Get a list of notes on the specified job	X
	Create a note on the specified job		X
	Get a list of cancel reasons for specific jobs	X
	Get a list of history entries for the specified job	X
	Create a message on a job		X
Leads	Get a lead specified by ID	X
	Update a lead		X
	Get a list of leads	X
	Create a lead		X
	Create a follow-up		X
	Get notes for a lead	X
	Create a note on the specified lead		X
	Dismiss a lead specified by ID		X
	Submit a lead form		X
Location labor type	Get a list of location hourly rates by multiple locations	X
Location recurring service events	Get a list of recurring service events	X
	Mark the specified recurring service event as complete		X
	Mark the specified recurring service event as incomplete		X
Location recurring services	Get a list of recurring services	X
	Get recurring service specified by ID	X
	Update specified recurring service in "patch" mode		X
Locations	Get a location specified by ID	X
	Update a location		X
	Create a new location		X
	Get a list of locations	X
	Get a list of notes on the specified location	X
	Create a note on the specified location		X
	Get a list of contacts for the specified location	X
	Create a contact on the location		X
	Get a list of contacts for a specific modified on date range or by their location IDs either location IDs	X
	Remove a contact from a location		X
	Update a contact on the location		X
Materials	Get details on materials in the pricebook	X
	Add a new material to your pricebook		X
	Get details on a material in the pricebook	X
	Edit an existing item in your pricebook		X
	Delete a material from your pricebook		X
Materials markup	Get materials markup collection	X
	Create materials markup item		X
	Get materials markup item	X
	Update materials markup item		X
Membership types	Get a list of membership types	X
	Get membership type specified by ID	X
	Get recurring services for the given membership type	X
	Get discounts for the given membership type	X
	Get duration/billing options for the given membership type	X
Non job appointments	Non job appointments Get	X
	Update an existing non Job appointment		X
	Delete non Job appointment		X
	Get s a list of non Job appointments	X
	Create a new non Job appointment		X
Payroll adjustments	Create new payroll adjustment		X
	Get a list of payroll adjustments	X
	Get payroll adjustment specified by ID	X
Payrolls	Get a list of payrolls	X
	Get a list of technician payrolls	X
	Get a list of employee payrolls	X
Performance	Return performance data	X
Pricebook bulk	Pricebook bulk create		X
Pricebook bulk	Pricebook bulk Update		X
Project statuses	Get a list of project statuses	X
Project statuses	Get a project status by ID	X
Project sub statuses	Get a list of project sub statuses	X
Project sub statuses	Get a project sub status by ID	X
Projects	Get a project by ID	X
	Update a project		X
	Get a list of projects	X
	Create a new project		X
	Get a list of notes on the specified project	X
	Create a note on the specified project		X
	Attach job to the specified project		X
	Detach job from the project		X
	Creates a message on a project		X
Purchase order types	Create a new purchase order type		X
	Get a list of purchase order types	X
	Update an existing purchase order type		X
Purchase orders	Create a new purchase order		X
	Get a list of purchase orders	X
	Get purchase order by ID	X
	Update an existing purchase order		X
	Cancel a purchase order		X
Purchase orders markup	Get a list of purchase order markups	X
	Create a new purchase order markup		X
	Get purchase order markup by ID	X
	Update an existing purchase order markup		X
	Delete an existing purchase order markup		X
Receipts	Get a list of receipts	X
	Create a receipt for purchase order		X
	Update custom fields on receipts		X
	Cancel the receipts		X
Recurring service types	Get a list of recurring service types	X
Recurring service types	Get recurring service type specified by ID	X
Report categories	List categories for existing reports	X
Report category reports	List reports within given category	X
	Get report description including input parameters and output fields etc take a note that the report description isn't fixed and may be changed by the report owner	X
	Get report data the result is based on current report description which isn't constant in general beware that report columns may be changed result field names are listed alongside the data in the response to validate that all the requested columns are there		X
Return types	Create a new return type	X
	Return the list of return types		X
	Update an existing return type	X
Returns	Get a list of returns	X
	Create a return		X
	Update custom fields on returns		X
	Update an existing return		X
	Cancel a return		X
Reviews	Review	X
Scheduled job attributions	Attribute a job to a web session		X
Service agreements	Get a list of service agreements	X
Service agreements	Get service agreement specified by ID	X
Services	Get data on all of the services in the pricebook	X
	Post to add a new service to your pricebook		X
	Get details a service in the pricebook	X
	Edit an existing item in your pricebook		X
	Delete a service from your pricebook		X
Suppressions	Get a paginated list of suppression	X
	Get suppression specified by an email	X
	Remove emails from a suppression list		X
	Add emails to a suppression list		X
Tag types	Get a list of tag types	X
Tasks	Get a list of tasks	X
	Task create		X
	Get a task by ID	X
	Task create subtask		X
Team	Get a list of teams	X
	Create new team		X
	Get a specific team	X
	Delete team		X
Technician rating	Add a rating for the specified technician		X
Technician shifts	Get a list of technician shifts	X
	Create new technician shift		X
	Get a specific technician shift	X
	Update technician shift		X
	Delete the specified technician shift		X
	Delete the technician shifts specified by the criteria		X
Technicians	Get a list of technicians	X
	Create new technician		X
	Get a technician by ID	X
	Update technician		X
	Perform standard actions with the account		X
Timesheet codes	Get a list of timesheet codes	X
Timesheet codes	Get timesheet code specified by ID	X
Timesheets	Get a list of job timesheets	X
	Create new job timesheet		X
	Get a list of non job timesheets for employee	X
	Get a list of job timesheets by multiple jobs	X
	Update specified job timesheet		X
Transfers	Get a list of transfers	X
	Update custom fields on transfers		X
	Update an existing transfer		X
Trucks	Get a list of trucks	X
Trucks	Update an existing truck		X
User roles	Get a list of user roles	X
Vendors	Create a new vendor		X
	Get a list of vendors	X
	Get vendor by ID	X
	Update an existing vendor		X
Warehouses	Get a list of warehouses	X
Warehouses	Update an existing warehouse		X
Web booking attributions	Attribute a web booking to a web session		X
Web lead form attributions	Attributes a web lead form to a web session		X
Zone	Get a list of zones	X
Zone	Get a specific zone	X