Overview

Developer portal: The ServiceTitan developer partner portal is a one-stop solution for partner developers looking to use and integrate with our APIs. Use our portal to discover APIs and read our comprehensive documentation to build your connection to our API services. Our developer portal is set up to address specific needs as you build.

Docs tab: Explore this tab to get familiar with all the required details from Getting started to, Creating Application key, Client ID & Secret etc. This section also gives you orientation to our resources which are fundamental to our APIs. The resources in this tab are periodically updated with the most current information. 

API Reference tab: Gives you a breakdown of all the APIs in our catalog. You can view all of the endpoints and learn our API structure and parameters to get started right away. 

Request Access: Lets you request for a Partner Credentials Management Portal. You need to be established as a registered user from a  ServiceTitan approved organization. After you become a user, you can 'Login to My apps' tab.

Partner Credential Management Portal: Once you login, based upon your role based access, you can register your Application and generate Application key. Manage your applications and generate Client ID & Secret keys. An application requires both Application key and Client ID & Secret key for making a successful API call. 

Making an API call:

To make a successful API call your app needs to possess: 

  • A Client ID & Secret Key granted for the application. 

  • An Application key (a.k.a App key) generated for the application. 

  • A Partner ID whose resources your app will access. 

A successful API call is a two step process. 

  1. Your application calls ServiceTitan OAuth 2.0 token endpoint and passes Client ID & Secret Key. If the validation is successful, you will get an access token. 

  2. Your application calls the Resource API endpoint and passes the access token along with the application key. If the validation is successful, then your GET/PUT/POST/DELETE operation will be successful. Note: The access token must be cached and reused during its lifetime of 15-minutes, there is no need to call the token endpoint before each API call.

Application key gets generated after a developer creates an app through the My Apps section in the portal. Application keys generated through an Integration environment login works in production and vice versa.

Client ID & Secret are generated by a ServiceTitan admin (resource owner) within your organization through your organization's instance of the ServiceTitan App and shared with the app developer securely. Client ID and the Secret Key are environment specific. Your ServiceTitan admin has to generate the Client ID and Secret Key separately in the Integration and production environments.