Get started with API dev portal V2Last updated on 06/07/2022
Know what to do to get started with Version 2 (V2) of ServiceTitan APIs. Once you complete the first steps, visit developer.servicetitan.io for full access to self-serve tools, including documentation, reference, FAQs, and more to help you build powerful and dynamic integrations to address your business needs.
Things to know
This is a quick reference guide to get you started. For a full version of all the items mentioned in this article, visit developer.servicetitan.io/docs/welcome/.
Tokens and information used in the images are for example only.
Before you start using our API dev portal, understand how it works, including how it validates key pairs, returns access tokens, and how to make a successful call.
Our V2 APIs offer a range of endpoints for features like Jobs, Projects, Invoices, Payroll, Pricebook, and more. We follow OAuth2.0 protocol and machine-to-machine grant flow.
A successful V2 API call looks like this:
Call OAuth 2.0 API, Pass Client ID and Secret Key. ServiceTitan validates the key pair and returns an access token.
Call individual API & Pass Access Token and App Key. ServiceTitan validates credentials and processes the API call.
For more information, see Make your first API call.
Step 1: Create an app
Before you start using our dev portal, you’ll need to create an app and generate an app key to move to the next step:
Go to developer.servicetitan.io.
Click Login to My Apps.
In the ServiceTitan Customers section, click Login as Integration Environment user or Login as Production Environment User. Note: Selections are based on your account access.
The ServiceTitan sign-in screen appears.
Enter your ServiceTitan credentials to sign in.
In My Apps, click +New App.
Enter your app details in all the fields.
In the Tenant(s) section, add tenant IDs.
In API Scope, select your endpoints.
An Application created! confirmation appears.
In the Keys > Application Key section, copy your key. You’ll need it to generate a Client ID and Secret Key.
Step 2: Generate a Client ID and Secret Key
Now that you’ve created an app and generated an app key, you’ll need to generate a Client ID and Secret Key:
In Servicetitan, go to the navigation bar and click Settings.
In the side panel, search Integrations.
Click API Application Access.
The Manage API Application Access section opens.
Click Connect New App.
A Connect New App pop-up opens to the available app for your account.
Find the application you want and click to select it.
Click Connect. A message asking you to access your account appears.
Review the access request. If it’s correct, click Allow Access.
An App connected! message appears.
In Application Details > Client ID, copy your Client ID. Go to Client Secret and click Generate to generate a secret key.
Share the Client ID and Secret Key with your app developer.
Additional API dev portal V2 resources
Want to learn more?
Important note: Some features may not be currently included in your account and additional configuration may be required. Please contact technical support for details.
Disclaimer: Information provided in this article is for informational purposes only and it should not be construed to be legal advice. Information provided in this article may also not constitute the most up-to-date legal or other information. You should not act or refrain from acting on the basis of any information in this article to meet any compliance requirements without seeking independent legal or other professional advice.