Skip to main content

Authorization

Follow this guide to create a new ServiceTitan credential that will allow Nexla to authenticate to and exchange data with your ServiceTitan account.
servicetitan_api_auth.png

ServiceTitan

Prerequisites​

ServiceTitan uses the OAuth 2.0 Client Credentials Grant flow (two-legged, machine-to-machine authentication) for all API access. To connect Nexla to ServiceTitan, you need a Client ID, Client Secret, Application Key (App Key), and your Tenant ID. These are obtained through the ServiceTitan Developer Portal and your ServiceTitan account settings.

Access the ServiceTitan Developer Portal​

The ServiceTitan Developer Portal is where you register your integration application and manage API credentials. You must have a ServiceTitan account to log in.

  1. Navigate to https://developer.servicetitan.io/ and click Login to My Apps.

  2. Sign in using the Production Environment option if you are connecting to your live ServiceTitan account, or the Integration Environment for testing and development purposes.

Create an Application and Obtain Your App Key​

The App Key is a unique identifier tied to your integration application in the ServiceTitan Developer Portal. It is required as an HTTP request header (ST-App-Key) on every API call to identify which developer application is making the request.

  1. After logging in to the Developer Portal, navigate to the My Apps tab.

  2. Click Create App and provide a descriptive name and description for your integration application (for example, "Nexla Integration").

  3. Add your ServiceTitan Tenant ID to the app and select the API scopes your integration requires. For use with Nexla, the relevant scopes include Job Planning, CRM, Dispatch, Pricebook, Sales, Equipment Systems, and Settings, corresponding to the endpoint categories available in the Nexla connector.

  4. Save the application. Your Application Key (App Key) will be generated and displayed in the Keys > Application Key section of the app details page. Copy it and store it securely — you will enter this value in Nexla as the Application Key field.

Obtain Your Client ID and Client Secret​

The Client ID and Client Secret are used together to request an OAuth 2.0 access token from the ServiceTitan authorization server at https://auth.servicetitan.io/connect/token.

  1. Log in to your ServiceTitan account (not the Developer Portal) and navigate to Settings using the toolbar at the top of the screen.

  2. In the settings side panel, search for Integrations and select API Application Access.

  3. In the Manage API Application Access section, click Connect New App.

  4. A pop-up will display the available applications registered to your account. Locate the application you created in the Developer Portal and click to select it.

  5. Review the access request and the listed API scopes, then click Allow Access to authorize the integration.

  6. Once access is granted, navigate to Application Details in the API Application Access section. Your Client ID is displayed there — copy it.

  7. Copy your Client Secret from the same Application Details section. Store both credentials securely, as the Client Secret grants API access to your ServiceTitan data.

Important

The Client ID and Client Secret are environment-specific. Credentials generated in the Production Environment cannot be used to authenticate against the Integration (sandbox) Environment. Ensure you generate credentials in the correct environment for your use case.

Find Your Tenant ID​

The Tenant ID is a numeric identifier that uniquely identifies your ServiceTitan organization. It is included in every API endpoint URL as a path parameter.

  1. Log in to the ServiceTitan Developer Portal and navigate to the My Apps tab.

  2. Your Tenant ID is listed in your application details. It is also available in your ServiceTitan account settings. Contact your ServiceTitan administrator if you need assistance locating it.

Additional details about obtaining and managing ServiceTitan API credentials are available in the ServiceTitan Developer Portal FAQ: App Key, Client ID & Secret.

Create a ServiceTitan Credential​

  • To create a new ServiceTitan credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

OAuth2 Client Credentials Configuration​

ServiceTitan uses the OAuth 2.0 Client Credentials Grant (two-legged) flow for machine-to-machine authentication. Nexla handles token retrieval and renewal automatically — access tokens expire after 15 minutes and Nexla will request a new one using the credentials below without interrupting your data flows.

  1. Enter your OAuth 2.0 Client ID in the Client ID field. This value is obtained from the Application Details section of API Application Access in your ServiceTitan account settings, as described in the Prerequisites above.

  2. Enter your OAuth 2.0 Client Secret in the Client Secret field. This is the corresponding secret associated with your Client ID. This value is treated as a password and will be stored securely by Nexla.

  3. Enter the OAuth 2.0 token endpoint URL in the Access Token URL field. The default value is https://auth.servicetitan.io/connect/token. This is the standard ServiceTitan authorization server endpoint and should not need to be changed.

  4. Enter your ServiceTitan organization's Tenant ID in the Tenant ID field. This numeric identifier is included in all ServiceTitan API endpoint URLs to route requests to the correct organization. See the Find Your Tenant ID section in Prerequisites above for instructions on locating this value.

  5. Enter your Application Key in the Application Key field. This is the ST-App-Key value generated in the ServiceTitan Developer Portal when you created your integration application. It is sent as an HTTP request header on every API call and identifies which developer application is making the request.

    The Application Key is distinct from the Client ID. The App Key identifies your integration application in the Developer Portal, while the Client ID and Client Secret authenticate your specific organization's authorized access to the API.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.