Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to ServiceTitan

Scalekit connector
Open markdown

The ServiceTitan connector lets your AI agent act in each user's ServiceTitan account. Each user signs in to ServiceTitan once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 29 tools.

Tools
29
What they doRead · write · destructive
19 · 9 · 119 read9 write1 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the ServiceTitan connection

    In AgentKit > Connections, create a ServiceTitan connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • servicetitan_appointment_assignments_listList technician assignments on job appointments in a ServiceTitan tenant, filtered by appointment, job, technician or appointment start date.Read-only

    List Appointment Assignments

    List technician assignments on job appointments in a ServiceTitan tenant, filtered by appointment, job, technician or appointment start date. Returns page, pageSize, hasMore, totalCount (when requested) and a data array. Each assignment has id, technicianId, technicianName, appointmentId, jobId, assignedOn and status. Use this to see who is assigned to what. Use servicetitan_appointments_list for appointment times.

    Inputs

    app_keystringrequired
    App Key of your ServiceTitan developer app, sent as the ST-App-Key header on every call. Find it in the ServiceTitan Developer Portal (developer.servicetitan.io) under My Apps > your app > Keys > Application Key. It belongs to the same app whose Client ID and Client Secret this connection uses. Example: ak1.abcd1234efgh5678ijkl
    tenant_idstringrequired
    Your ServiceTitan tenant ID (a number). An admin finds it in ServiceTitan under Settings > Integrations > API Application Access, next to the connected app. Example: 1234567890
    activestring
    Which assignments to return by active status: True (active only), False (inactive only) or Any. ServiceTitan's default: only active records are returned by default. Example: Anyone of TrueAnyFalse
    appointment_idsstring
    Comma-separated appointment IDs to return assignments for. Example: 567890,567891
    appointment_starts_beforestring
    Return assignments whose appointment starts before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    appointment_starts_on_or_afterstring
    Return assignments whose appointment starts on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    created_beforestring
    Return records created before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    created_on_or_afterstring
    Return records created on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    idsstring
    Comma-separated list of assignment IDs to look up (maximum 50). Example: 101,102,103
    include_totalboolean
    Set to true to include the total record count in the response (totalCount). Example: true
    job_idinteger
    Return assignments for this job. Example: 456789
    modified_beforestring
    Return records modified before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    modified_on_or_afterstring
    Return records modified on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    pageinteger
    Page number to return, starting from 1. Example: 2
    page_sizeinteger
    How many records to return per page (ServiceTitan's default is 50). Example: 100
    sortstring
    Sort order: +FieldName for ascending or -FieldName for descending. Available fields: Id, CreatedOn, ModifiedOn. Example: -ModifiedOn
    technician_idsstring
    Comma-separated technician IDs to return assignments for. Example: 5001,5002
  • servicetitan_appointments_listList job appointments in a ServiceTitan tenant, filtered by job, customer, technician, status or start, created and modified dates.Read-only

    List Appointments

    List job appointments in a ServiceTitan tenant, filtered by job, customer, technician, status or start, created and modified dates. Returns page, pageSize, hasMore, totalCount (when requested) and a data array. Each appointment has id, jobId, appointmentNumber, start, end, arrival window, status and customerId. Use this to see the schedule. Use servicetitan_appointment_assignments_list for which technicians are assigned.

    Inputs

    app_keystringrequired
    App Key of your ServiceTitan developer app, sent as the ST-App-Key header on every call. Find it in the ServiceTitan Developer Portal (developer.servicetitan.io) under My Apps > your app > Keys > Application Key. It belongs to the same app whose Client ID and Client Secret this connection uses. Example: ak1.abcd1234efgh5678ijkl
    tenant_idstringrequired
    Your ServiceTitan tenant ID (a number). An admin finds it in ServiceTitan under Settings > Integrations > API Application Access, next to the connected app. Example: 1234567890
    activestring
    Which appointments to return by active status: True (active only), False (inactive only) or Any. ServiceTitan's default: only active records are returned by default. Example: Anyone of TrueAnyFalse
    created_beforestring
    Return records created before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    created_on_or_afterstring
    Return records created on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    customer_idinteger
    Return appointments for this customer. Example: 123456
    idsstring
    Comma-separated list of appointment IDs to look up (maximum 50). Example: 101,102,103
    include_totalboolean
    Set to true to include the total record count in the response (totalCount). Example: true
    job_idinteger
    Return appointments for this job. Example: 456789
    modified_beforestring
    Return records modified before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    modified_on_or_afterstring
    Return records modified on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    pageinteger
    Page number to return, starting from 1. Example: 2
    page_sizeinteger
    How many records to return per page (ServiceTitan's default is 50). Example: 100
    sortstring
    Sort order: +FieldName for ascending or -FieldName for descending. Available fields: Id, ModifiedOn, CreatedOn. Example: -ModifiedOn
    starts_beforestring
    Return appointments that start before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    starts_on_or_afterstring
    Return appointments that start on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    statusstring
    Return appointments with this status: Scheduled, Dispatched, Working, Hold, Done or Canceled. Example: Scheduledone of ScheduledDispatchedWorkingHoldDoneCanceled
    technician_idinteger
    Return appointments this technician is assigned to. Example: 5001
  • servicetitan_business_units_listList business units in a ServiceTitan tenant, optionally filtered by name or active status.Read-only

    List Business Units

    List business units in a ServiceTitan tenant, optionally filtered by name or active status. Returns page, pageSize, hasMore, totalCount (when requested) and a data array. Each business unit has id, name, officialName, email, phoneNumber, address and active. Use this to get the business_unit_id that servicetitan_job_create needs.

    Inputs

    app_keystringrequired
    App Key of your ServiceTitan developer app, sent as the ST-App-Key header on every call. Find it in the ServiceTitan Developer Portal (developer.servicetitan.io) under My Apps > your app > Keys > Application Key. It belongs to the same app whose Client ID and Client Secret this connection uses. Example: ak1.abcd1234efgh5678ijkl
    tenant_idstringrequired
    Your ServiceTitan tenant ID (a number). An admin finds it in ServiceTitan under Settings > Integrations > API Application Access, next to the connected app. Example: 1234567890
    activestring
    Which business units to return by active status: True (active only), False (inactive only) or Any. ServiceTitan's default: only active records are returned by default. Example: Anyone of TrueAnyFalse
    created_beforestring
    Return records created before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    created_on_or_afterstring
    Return records created on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    idsstring
    Comma-separated list of business unit IDs to look up (maximum 50). Example: 101,102,103
    include_totalboolean
    Set to true to include the total record count in the response (totalCount). Example: true
    modified_beforestring
    Return records modified before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    modified_on_or_afterstring
    Return records modified on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    namestring
    Return business units whose name contains this text (case-insensitive). Example: HVAC
    pageinteger
    Page number to return, starting from 1. Example: 2
    page_sizeinteger
    How many records to return per page (ServiceTitan's default is 50). Example: 100
    sortstring
    Sort order: +FieldName for ascending or -FieldName for descending. Available fields: Id, Name, CreatedOn, ModifiedOn. Example: -ModifiedOn
  • servicetitan_campaigns_listList marketing campaigns in a ServiceTitan tenant, optionally filtered by name, phone number or active status.Read-only

    List Campaigns

    List marketing campaigns in a ServiceTitan tenant, optionally filtered by name, phone number or active status. Returns page, pageSize, hasMore, totalCount (when requested) and a data array. Each campaign has id, name, category, active and campaign phone numbers. Use this to get the campaign_id that servicetitan_job_create and servicetitan_lead_create need.

    Inputs

    app_keystringrequired
    App Key of your ServiceTitan developer app, sent as the ST-App-Key header on every call. Find it in the ServiceTitan Developer Portal (developer.servicetitan.io) under My Apps > your app > Keys > Application Key. It belongs to the same app whose Client ID and Client Secret this connection uses. Example: ak1.abcd1234efgh5678ijkl
    tenant_idstringrequired
    Your ServiceTitan tenant ID (a number). An admin finds it in ServiceTitan under Settings > Integrations > API Application Access, next to the connected app. Example: 1234567890
    activestring
    Which campaigns to return by active status: True (active only), False (inactive only) or Any. ServiceTitan's default: only active records are returned by default. Example: Anyone of TrueAnyFalse
    campaign_phone_numberstring
    Return campaigns that use this phone number. Example: 5555550100
    created_beforestring
    Return records created before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    created_on_or_afterstring
    Return records created on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    idsstring
    Comma-separated list of campaign IDs to look up (maximum 50). Example: 101,102,103
    include_totalboolean
    Set to true to include the total record count in the response (totalCount). Example: true
    modified_beforestring
    Return records modified before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    modified_on_or_afterstring
    Return records modified on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    namestring
    Return campaigns whose name contains this text (case-insensitive). Example: Google Ads
    pageinteger
    Page number to return, starting from 1. Example: 2
    page_sizeinteger
    How many records to return per page (ServiceTitan's default is 50). Example: 100
    sortstring
    Sort order: +FieldName for ascending or -FieldName for descending. Available fields: Id, Name, CreatedOn, ModifiedOn. Example: -ModifiedOn
  • servicetitan_customer_contacts_listList the contact methods (phone, mobile, email, fax) saved on a ServiceTitan customer.Read-only

    List Customer Contacts

    List the contact methods (phone, mobile, email, fax) saved on a ServiceTitan customer. Returns page, pageSize, hasMore, totalCount (when requested) and a data array. Each contact has id, type, value, memo and phoneSettings. Use this to get a customer's phone number or email. Use servicetitan_customer_get for the customer's address and flags.

    Inputs

    app_keystringrequired
    App Key of your ServiceTitan developer app, sent as the ST-App-Key header on every call. Find it in the ServiceTitan Developer Portal (developer.servicetitan.io) under My Apps > your app > Keys > Application Key. It belongs to the same app whose Client ID and Client Secret this connection uses. Example: ak1.abcd1234efgh5678ijkl
    customer_idstringrequired
    ID of the customer. Example: 123456
    tenant_idstringrequired
    Your ServiceTitan tenant ID (a number). An admin finds it in ServiceTitan under Settings > Integrations > API Application Access, next to the connected app. Example: 1234567890
    include_totalboolean
    Set to true to include the total record count in the response (totalCount). Example: true
    pageinteger
    Page number to return, starting from 1. Example: 2
    page_sizeinteger
    How many records to return per page (ServiceTitan's default is 50). Example: 100
  • servicetitan_customer_getGet one ServiceTitan customer by ID.Read-only

    Get Customer

    Get one ServiceTitan customer by ID. Returns the customer's name, type (Residential or Commercial), bill-to address, balance, flags such as doNotService, tags, custom fields and created/modified dates. Use servicetitan_customers_list to search when you don't have the ID. Use servicetitan_customer_contacts_list for phone numbers and emails.

    Inputs

    app_keystringrequired
    App Key of your ServiceTitan developer app, sent as the ST-App-Key header on every call. Find it in the ServiceTitan Developer Portal (developer.servicetitan.io) under My Apps > your app > Keys > Application Key. It belongs to the same app whose Client ID and Client Secret this connection uses. Example: ak1.abcd1234efgh5678ijkl
    customer_idstringrequired
    ID of the customer. Get it from servicetitan_customers_list. Example: 123456
    tenant_idstringrequired
    Your ServiceTitan tenant ID (a number). An admin finds it in ServiceTitan under Settings > Integrations > API Application Access, next to the connected app. Example: 1234567890
  • servicetitan_customers_listList customers in a ServiceTitan tenant, filtered by name, address, phone, active status or created/modified dates.Read-only

    List Customers

    List customers in a ServiceTitan tenant, filtered by name, address, phone, active status or created/modified dates. Returns page, pageSize, hasMore, totalCount (when requested) and a data array. Each customer has id, name, type, address, balance, doNotService, active and custom fields. Use this to find a customer ID. Use servicetitan_customer_get when you already have the ID.

    Inputs

    app_keystringrequired
    App Key of your ServiceTitan developer app, sent as the ST-App-Key header on every call. Find it in the ServiceTitan Developer Portal (developer.servicetitan.io) under My Apps > your app > Keys > Application Key. It belongs to the same app whose Client ID and Client Secret this connection uses. Example: ak1.abcd1234efgh5678ijkl
    tenant_idstringrequired
    Your ServiceTitan tenant ID (a number). An admin finds it in ServiceTitan under Settings > Integrations > API Application Access, next to the connected app. Example: 1234567890
    activestring
    Which customers to return by active status: True (active only), False (inactive only) or Any. ServiceTitan's default: only active records are returned by default. Example: Anyone of TrueAnyFalse
    citystring
    Return customers in this city. Example: Austin
    created_beforestring
    Return records created before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    created_on_or_afterstring
    Return records created on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    idsstring
    Comma-separated list of customer IDs to look up (maximum 50). Example: 101,102,103
    include_totalboolean
    Set to true to include the total record count in the response (totalCount). Example: true
    modified_beforestring
    Return records modified before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    modified_on_or_afterstring
    Return records modified on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    namestring
    Return customers with this name. Example: Jane Smith
    pageinteger
    Page number to return, starting from 1. Example: 2
    page_sizeinteger
    How many records to return per page (ServiceTitan's default is 50). Example: 100
    phonestring
    Return customers that have a contact with this phone number. Example: 5555551234
    sortstring
    Sort order: +FieldName for ascending or -FieldName for descending. Available fields: Id, ModifiedOn, CreatedOn. Example: -ModifiedOn
    statestring
    Return customers in this state. Example: TX
    streetstring
    Return customers on this street. Example: 123 Main St
    zipstring
    Return customers with this zip or postal code. Example: 78701
  • servicetitan_invoices_listList invoices in a ServiceTitan tenant, filtered by customer, job, business unit, invoice date, due date, total or status.Read-only

    List Invoices

    List invoices in a ServiceTitan tenant, filtered by customer, job, business unit, invoice date, due date, total or status. By default all invoices are returned regardless of status. Returns page, pageSize, hasMore, totalCount (when requested) and a data array. Each invoice has id, referenceNumber, invoiceDate, dueDate, subTotal, salesTax, total, balance, customer, location, businessUnit, job and syncStatus. Use servicetitan_payments_list for payments received.

    Inputs

    app_keystringrequired
    App Key of your ServiceTitan developer app, sent as the ST-App-Key header on every call. Find it in the ServiceTitan Developer Portal (developer.servicetitan.io) under My Apps > your app > Keys > Application Key. It belongs to the same app whose Client ID and Client Secret this connection uses. Example: ak1.abcd1234efgh5678ijkl
    tenant_idstringrequired
    Your ServiceTitan tenant ID (a number). An admin finds it in ServiceTitan under Settings > Integrations > API Application Access, next to the connected app. Example: 1234567890
    active_statestring
    Which invoices to return by active state: ActiveOnly, InactiveOnly or All. Example: Allone of ActiveOnlyInactiveOnlyAll
    business_unit_idinteger
    Return invoices for this business unit. Example: 789
    customer_idinteger
    Return invoices for this customer. Example: 123456
    due_date_beforestring
    Return invoices due before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    due_date_on_or_afterstring
    Return invoices due on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    idsstring
    Comma-separated list of invoice IDs to look up (maximum 50). Example: 101,102,103
    include_totalboolean
    Set to true to include the total record count in the response (totalCount). Example: true
    invoiced_on_beforestring
    Return invoices dated before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    invoiced_on_or_afterstring
    Return invoices dated on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    job_idinteger
    Return invoices linked to this job. Example: 456789
    job_numberstring
    Return invoices linked to this job number. Example: 10045
    modified_beforestring
    Return invoices modified before this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    modified_on_or_afterstring
    Return invoices modified on or after this date/time (ISO 8601 date-time in UTC). Example: 2026-01-01T00:00:00Z
    numberstring
    Return invoices with this reference number. Example: 10045
    pageinteger
    Page number to return, starting from 1. Example: 2
    page_sizeinteger
    How many records to return per page (ServiceTitan's default is 50). Example: 100
    statusesarray
    Transaction statuses to include: Pending, Posted or Exported. All statuses are included by default. Example: ["Posted"]
    total_greaternumber
    Return invoices with a total greater than or equal to this amount. Example: 100
    total_lessnumber
    Return invoices with a total less than or equal to this amount. Example: 5000