Skip to main content

ServiceTitan API Integration Requirements

Overview of each ServiceTitan endpoint required for Pika AutoFile

Ryan Jiang avatar
Written by Ryan Jiang
Updated this week

Invoices

Endpoint

Permission Level

Explanation

Invoices

Write

Allows Pika QA team to manually correct invoices when necessary (i.e., during kickbacks or pre-submission validation)

Invoice Items

Write

Allows Pika QA team to manually correct invoices when necessary (i.e., during kickbacks or pre-submission validation)

CRM

Endpoint

Permission Level

Explanation

Customers

Read

Allows Pika QA team to manually correct customer information (i.e., addresses/contact information) and for users to provide emails through the Pika dashboard. Contact information is synced back to ServiceTitan with a Pika tag.

Booking Provider Tags

Read

Jobs can be imported automatically into the dashboard based on tags that install coordinators or dispatchers place onto the job (e.g., “Pika Rebate Needed”, or “Oncor Eligible”)

Bookings

Read

Used for automatically pulling in appointments and jobs

BulkTags

Read

Used for automatically pulling in appointments and jobs

ContactMethods

Read

Used for homeowner communications

Contacts

Read

Used for homeowner communications

Customers

Read

Required for rebate submissions

Leads

Read

Used for historical notes and forms (helpful for various rebate submissions)

Locations

Read

Required for rebate submissions (address and installed equipment)

Dispatch

Endpoint

Permission Level

Explanation

AppointmentAssignments

Read

Used for automatic import of jobs and appointments

ArrivalWindows

Read

Used for displaying upcoming jobs (i.e., QA jobs) and displaying relevant timeframes

Equipment Systems

Endpoint

Permission Level

Explanation

InstalledEquipment

Read

Required for rebate submissions for replaced unit model numbers and installation dates

Forms

Endpoint

Permission Level

Explanation

Forms

Read

Recommended workflow for guaranteeing technician documentation (i.e., equipment photos, model numbers, manual J, QA checklist)

FormSubmission

Read

Recommended workflow for guaranteeing technician documentation (i.e., equipment photos, model numbers, manual J, QA checklist)

Jobs

Read

Required for retrieving attachments (i.e., equipment photos, certification PDFs)

Pricebook

Endpoint

Permission Level

Explanation

Categories

Read

Used for referencing pricebook items that are picked up via auto import

DiscountsAndFees

Read

Required for final pricing/amount estimation before rebate submissions

Services

Read

Service SKUs are used for auto-import; services often have additional equipment information if shop uses services to add linked Materials and Equipment. Some shops also use negative-price services as a more customizable version of discounts.

Equipment

Read

Required for line item costing and model numbers

Materials

Read

Required for line item costing. Some shops also use materials in place of equipment, or as discounts.

Service Agreements

Endpoint

Permission Level

Explanation

ServiceAgreements

(*Optional)

Read

Utilized for validation for repeat submissions (i.e., multiple filings per annum)

Sales and Estimates

Endpoint

Permission Level

Explanation

Estimates

Read

Used for auto-importing relevant jobs and appointments based on particular SKUs or services (i.e., Carrier Infinity Heat Pump sold estimates would get imported)

Settings

Endpoint

Permission Level

Explanation

Business Units

Read

Allows restricting imported jobs by business unit (Sales).

[Coming soon] Granular access controls by employee business unit.

Employees

Read

Used for coordinating directly with assigned technicians and employees.

[Coming soon] RBAC & permissions alignment with ServiceTitan.

TagTypes

Read

Required for automatic importing appointments and jobs

Technicians

Read

Used for coordinating directly with assigned technicians and employees.

[Coming soon] RBAC & permissions alignment with ServiceTitan.

UserRoles

Read

Used for coordinating directly with assigned technicians and employees.

[Coming soon] RBAC & permissions alignment with ServiceTitan.

Did this answer your question?