--- title: "Get started with API dev portal V2" slug: "get-started-with-api-dev-portal-v2" updated: 2026-10-16T01:20:44Z published: 2026-10-16T01:20:44Z canonical: "help.servicetitan.com/get-started-with-api-dev-portal-v2" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.servicetitan.com/llms.txt > Use this file to discover all available pages before exploring further. # Get started with API dev portal V2 ## Overview Know what to do to get started with Version 2 (V2) of ServiceTitan APIs. Once you complete the first steps, visit [developer.servicetitan.io](https://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. --- ### #### Who uses this feature - Developers and office employees consuming APIs and managing other integrations for their business - To have an integration environment instance created, visit [developer.servicetitan.io,](https://developer.servicetitan.io/) then click **Request Access**. These instances are used for development and testing activities. For customers with production systems, your integration environment instance will be a clone of your production system and production data. ## 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/](https://developer.servicetitan.io/docs/welcome/). - Tokens and information used in the images are for example only. - Administrators can access the Dev Portal directly by logging into their ServiceTitan account at [https://developer.servicetitan.io/signin/](https://developer.servicetitan.io/signin/) and using the **Login as Production Environment User** option. This can be used to generate or obtain your Client ID, Client Secret, and Tenant ID. > **Note:** You must log in with your ServiceTitan account. You cannot log in with Enterprise Hub or Partner Portal logins. - To access the Dev Portal, you must have the following permissions enabled by an administrator on your team: - Generate API Application Key - Manage API Application Access ## API infrastructure 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. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-s0vm8av7.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) A successful V2 API call looks like this: 1. Call [OAuth 2.0 API](https://developer.servicetitan.io/docs/oauth20/), Pass Client ID and Secret Key. ServiceTitan validates the key pair and returns an access token. 2. 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](https://developer.servicetitan.io/docs/get-going-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: 1. Go to [developer.servicetitan.io](https://developer.servicetitan.io/). 2. Click **Login to My Apps**. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-tj7fsp7c.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) 3. In the *ServiceTitan Customers* section, click **Login as Integration Environment user** or **Login as Production Environment User**.*![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-lzwodaej.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D)* The ServiceTitan sign-in screen appears. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-uayxa6tc.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) > **Note:** *Selections are based on your account access.* 4. Enter your ServiceTitan credentials to sign in. 5. In *My Apps*, click **+New App**. 6. Enter your app details in all the fields. 1. In *the Tenant(s)* section, add tenant IDs. 2. In *API Scope*, select your endpoints. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-v8iym0ds.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) 7. An *Application created!* confirmation appears. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-jnn94yog.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) 8. 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: 1. In [ServiceTitan](https://go.servicetitan.com/#/new/dashboards/modular-dashboard), go to the top toolbar and click **Settings** ![A simple icon representing a settings gear.](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/icon-gnav-settings-inactive.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) . 2. In the side panel, search for **Integrations**. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-cefbv34d.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) 3. Click **API Application Access**. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-nt6i5ywb.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) The *Manage API Application Access* section opens. 4. Click **Connect New App**. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-js87p1n8.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) A *Connect New App* pop-up opens to the available app for your account. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-x1s23uc1.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) 5. Find the application you want and click to select it. The list of available options is generated from the apps you created in [Step 1](/v1/docs/get-started-with-api-dev-portal-v2#step-1-create-an-app). If you can't find your app, please contact [Technical Support](http://go.servicetitan.com/ask). 6. Click **Connect**. A message appears, asking you to access your account. 7. Review the access request. If it's correct, click **Allow Access**. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-0dq6o7rd.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) An *App connected!* message appears. 8. In **Application Details > Client ID**, copy your Client ID. Go to *Client Secret* and click **Generate** to generate a secret key. ![](https://cdn.document360.io/961862ab-d0f2-4d91-bb62-a62ee8184eff/Images/Documentation/get-started-with-api-dev-portal-v2-image-5qya7k8e.png?sv=2026-02-06&spr=https&st=2026-10-27T04%3A36%3A10Z&se=2026-10-27T05%3A36%3A10Z&sr=c&sp=r&sig=cud%2FBhU%2F%2Fm0URCP9QwRCLtLEKgOsGwx%2BlaxTL1NBgXQ%3D) 9. Share the Client ID and Secret Key with your app developer. > **Note:** Depending on the app you are trying to connect, the setup may differ from what appears in this article. ## Additional API dev portal V2 resources - [Dev portal overview](https://developer.servicetitan.io/docs/overview/) - [Getting access](https://developer.servicetitan.io/docs/get-going-getting-access/) - [API reference](https://developer.servicetitan.io/apis/) - [FAQs](https://developer.servicetitan.io/docs/faqs-environments/) ## Want to learn more? - Visit [developer.servicetitan.io](https://developer.servicetitan.io/)