Skip to main content

Setting up the ServiceTitan API

Ryan Jiang avatar
Written by Ryan Jiang
Updated yesterday

Related:

1. Login to ServiceTitan Developer Portal

  • Then, click on “Login as Production Environment User"

  • Login with your ServiceTitan credentials – if you see a “User doesn’t have access to developer portal.” error message, try using an administrator account

  • If the “API Terms of Use” pops up, please click “Accept”

  • You should now be logged into a screen that says “My Apps” at the top

2. Setting up API scope

  • Click on “+ New App” at the top of the screen

  • You should now see a screen with “New App” at the top

  • Under “Developer Details”

    • Organization - your company name

    • Homepage - your website

    • Email Address - will be your ServiceTitan administrator account email

    • Are you a third-party developer? - select: “No, I’m a ServiceTitan customer”

  • Under “App Details”

    • Application name – enter: “ File rebates and registrations for (your company name)”

    • Description – add in a short description of the app (e.g. “Filing rebates and other paperwork for our equipment sales)

    • App Category – select “Rebates Platform” under “Sales Tool”

    • Tenant(s) – should be pre-filled, please don’t change

  • App Scopes

    • Please check the following permissions for each scope

    • For permissions marked as “All”, please click on “All” at the top of that category

    • For permissions marked as “Read + Write”, please check the boxes for both the Read and Write column just for the permissions listed in bullet points

    • For permissions marked as “Read for all”, please check all of the boxes under the Read column for all permissions within that Scope

Scope

Permissions Requested

Accounting

  • Invoice Items

  • Invoices

Read + Write for these two permissions

CRM

Read for all

Dispatch

Read for all

Equipment Systems

Read for all

Job Booking

Read for all

Job Planning and Management

Read for all

Pricebook

Read for all

Forms

Read for all

Service Agreements

Read for all

Sales & Estimates

Read for all

Settings

Read for all

Task Management

Read for all

[IMPORTANT] Scroll down to the bottom of the page and click the blue “Create App” button – this should bring you back to the page with “My Apps” at the top of the screen

3. Connect the application

  1. Please open a new tab and log into your regular ServiceTitan portal with your administrator account

  2. Click the gear icon for settings in the top right of the ServiceTitan page after logging in

  3. On the Settings page, click “Integrations” and then “API Application Access” on the left

  4. Click the blue “Connect New App” button

  5. In the menu that pops up, scroll down until you see Service Pitch and click “Connect”

  6. If there is a popup that has a few dropdown menus, select “No restriction” for “booking_provider” and “report_category”, and select “Native” for “gps_pings” – this may not apply

  7. Click the blue “Allow Access” button at the bottom right of the screen

4. Sharing API credentials

  1. Please switch back to the original ServiceTitan Developer Portal tab (developer.servicetitan.io)

  2. Scroll down the “My Apps” page until you find the app under Pika that you just created

    1. Click “Edit”

    2. Scroll down to Application Key, and click the “Copy” button to the right of the field (the value pre-filled should start with “ak1…”)

    3. Save that value (i.e. copy and paste it somewhere)

      1. “App Key”

  3. Navigate back to the “My Apps” screen and scroll down to find Pika again

    1. Click “View Connections”

    2. Click the blue “Generate” button under “Client Secret”

  4. Save the following four values (i.e. copy-and-paste them somewhere):

    1. Tenant ID – should be a number

    2. Client ID – should be a long string of letters and numbers starting with cid…

    3. Client Secret – should be a long string of letters and numbers starting with cs…

    4. App key - from section 2C above!

  5. Log into the Pika rebate portal and visit rebates.app.withpika.com/settings/integrations.

  6. Add in the Tenant ID, Client ID, Client Secret, and App Key from above and press "Check Integration Status". You should see the validation results display with all green check marks.

Did this answer your question?