Skip to main content
ServiceTitan logo
  • Category: scheduling & booking
  • Auth: S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 585
  • Triggers: 0
  • Slug: SERVICETITAN
  • Version: 20261101_00

Tools

Slug: SERVICETITAN_ACTIVATE_EMPLOYEE_ACCOUNTActivate a ServiceTitan employee’s login account.

Input Parameters

integer
required
Id of the employee whose login account to activate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ACTIVATE_TECHNICIAN_ACCOUNTActivate a ServiceTitan technician’s login account with the required license type and, optionally, assign a truck.

Input Parameters

integer
Optional truck Id to assign to the technician.
string ("NonManagedTechnician" | "ManagedTechnician" | "ManagedInstaller")
required
License type to assign during activation: NonManagedTechnician, ManagedTechnician or ManagedInstaller.
integer
required
Id of the technician whose login account to activate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ADD_CREDIT_MEMO_SPLITSApply a credit memo to one or more invoices in ServiceTitan by adding splits, each an invoice id and an amount. Splits are added to the memo’s existing ones; this operation does not remove or replace them.

Input Parameters

array
required
Splits to add, each applying part of the credit memo to one invoice.
integer
required
Id of the credit memo.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ADD_CUSTOMER_TAGAdd one tag type to one customer in ServiceTitan. Both ids go in the path and no request body is sent; use ADD_TAGS_TO_CUSTOMERS for several at once.

Input Parameters

integer
required
Id of the customer.
integer
required
Id of the tag type, as defined in the Settings tag types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ADD_EQUIPMENT_TO_EQUIPMENT_SYSTEMAttach existing installed equipment to a ServiceTitan equipment system, by system id and a list of installed equipment ids. Returns the updated system.

Input Parameters

array
required
Installed equipment IDs to attach to the system.
integer
required
Id of the equipment system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ADD_LOCATION_TAGAdd one tag type to one location in ServiceTitan. Both ids go in the path and no request body is sent. There is no bulk variant for locations; call once per location and tag.

Input Parameters

integer
required
Id of the location.
integer
required
Id of the tag type, as defined in the Settings tag types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ADD_TAGS_TO_CUSTOMERSAdd one or more tag types to several customers in ServiceTitan in one call. Every tag type listed is added to every customer listed; use ADD_CUSTOMER_TAG for a single customer and tag.

Input Parameters

array
required
Ids of the customers to tag.
array
required
Ids of the tag types to add to every customer listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_APPROVE_PURCHASE_ORDER_REQUESTApprove a ServiceTitan purchase order request by its request id. Takes the request id from LIST_PURCHASE_ORDER_REQUESTS, not a purchase order id. No way to withdraw an approval is documented.

Input Parameters

integer
required
Id of the purchase order request to approve; this is not a purchase order id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ASSIGN_TECHNICIAN_SKILLSAssign existing skills to a ServiceTitan technician. With replace_existing_skills true the technician’s current skills are replaced by the given list; with false the list is added.

Input Parameters

array
required
IDs of the skills to give the technician.
integer
required
ID of the technician to assign skills to.
boolean
required
True replaces all of the technician’s existing skills with skill_ids; False adds skill_ids to the existing skills.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ASSIGN_TECHNICIANS_TO_APPOINTMENTAssign one or more technicians to a ServiceTitan job appointment. Returns the appointment.

Input Parameters

integer
required
ID of the job appointment to assign technicians to.
array
required
IDs of the technicians to assign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ATTACH_JOB_EQUIPMENTAttach one or more equipment items to a ServiceTitan job. Returns the full list of equipment IDs attached after the change. The spec does not say which equipment ids these are; they are not the equipment system ids of the equipment-system tools, and whether installed-equipment ids (LIST_INSTALLED_EQUIPMENT) or pricebook equipment ids (LIST_PRICEBOOK_EQUIPMENT) are meant is unverified.

Input Parameters

integer
required
ID of the job.
array
required
IDs of the equipment items to attach to the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_ATTACH_JOB_TO_PROJECTAttach an existing ServiceTitan job to a project. Takes no body.

Input Parameters

integer
required
ID of the job to attach to the project.
integer
required
ID of the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_BULK_CREATE_INSTALLED_EQUIPMENTCreate up to 1000 installed equipment records in ServiceTitan in one atomic request. If any record is invalid the whole batch is rolled back and nothing is created.

Input Parameters

array
required
Installed equipment records to create. Must contain between 1 and 1000 items; the entire batch is created atomically and fails as a unit if any item is invalid. Nested keys use the documented spelling, for example locationId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_BULK_CREATE_PRICEBOOK_ITEMSCreate many ServiceTitan pricebook items in one request: services, equipment, materials, and discounts and fees. At least one of those four collections must contain an item. Give each item a customId; links inside the same request (serviceMaterials, recommendations, upgrades) can point to it by customId, and the response maps each customId to its new id.

Input Parameters

array
Pricebook services to write.
array
Pricebook equipment items to write.
array
Pricebook materials to write.
array
Pricebook discounts and fees to write.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_BULK_DELETE_TECHNICIAN_SHIFTSDelete every ServiceTitan technician shift in a date range, for all technicians. The only criteria are start and end; there is no technician filter, so check the range with List Technician Shifts first.

Input Parameters

string
required
End of the range; shifts inside the range are deleted. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Start of the range; shifts inside the range are deleted. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_BULK_UPDATE_PRICEBOOK_ITEMSUpdate many ServiceTitan pricebook items in one request: services, equipment, materials, and discounts and fees. At least one of those four collections must contain an item. Each item must carry its id and the documented full set of fields, not just the changed ones.

Input Parameters

array
Pricebook services to write.
array
Pricebook equipment items to write.
array
Pricebook materials to write.
array
Pricebook discounts and fees to write.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CANCEL_INVENTORY_RECEIPTCancel a ServiceTitan inventory receipt by id, optionally recording a cancellation reason. This cannot be undone through the API: no way to reopen a canceled inventory receipt is documented.

Input Parameters

integer
Optional query id documented separately from the receipt_id path parameter. Its purpose is not described by ServiceTitan.
integer
required
Id of the inventory receipt to cancel.
string ("NotRequired" | "Duplicate" | "Accidental" | "VendorIssue" | "Other" | "JobCanceled")
Reason the inventory receipt is canceled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CANCEL_INVENTORY_RETURNCancel a ServiceTitan vendor return by id, optionally recording a cancellation reason. This cannot be undone through the API: no way to reopen a canceled vendor return is documented.

Input Parameters

integer
required
Id of the vendor return to cancel.
string ("NotRequired" | "Duplicate" | "Accidental" | "VendorIssue" | "Other" | "JobCanceled")
Reason the vendor return is canceled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CANCEL_JOBCancel a ServiceTitan job with a cancel reason and memo. Jobs cannot be deleted, only canceled; get the reason ID from List Job Cancel Reasons.

Input Parameters

string
required
Memo of job cancel reason.
integer
required
ID of the job.
integer
required
ID of job cancel reason.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CANCEL_PURCHASE_ORDERCancel a ServiceTitan purchase order by id, optionally recording a cancellation reason. This cannot be undone through the API: no way to reopen a canceled purchase order is documented.

Input Parameters

string ("NotRequired" | "Duplicate" | "Accidental" | "VendorIssue" | "Other" | "JobCanceled")
Reason the purchase order is canceled.
integer
required
Id of the purchase order to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CANCEL_REPORT_DATA_QUERYCancel a long-running report data query in ServiceTitan and release its query_token. Succeeds even if the query had already finished; the result can no longer be fetched afterwards.

Input Parameters

string
required
Token of the long-running query, returned when the query was started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CONFIRM_APPOINTMENTMark a ServiceTitan job appointment as confirmed. Takes no body; the appointment’s isConfirmed flag becomes true.

Input Parameters

integer
required
ID of the job appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_ADJUSTMENT_INVOICECreate an adjustment invoice against an existing ServiceTitan invoice, such as for a refund or write-off. The result contains the integer returned by ServiceTitan; its meaning is not specified.

Input Parameters

number
Tax amount.
array
Invoice line items. Each entry needs description and quantity.
string
Invoice number.
string
Invoice summary (HTML allowed).
integer
Id of the invoice type.
number
Subtotal before tax.
string
Identifier assigned when the record was exported.
string
Invoice date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the tax zone; see LIST_TAX_ZONES.
string
Royalty date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Royalty memo.
string ("NeedsReview" | "OnHold" | "Reviewed" | "PendingApproval" | "Rejected" | "ReadyForBilling" | "Invoiced")
Review status of the invoice.
integer
Id of the user the invoice is assigned to.
integer
Id of the budget code.
string ("Pending" | "Sent" | "Failed")
Indicates royalty status of invoice.
string
When the royalty was sent. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
Id of the existing invoice that this adjustment invoice adjusts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_APPOINTMENTAdd a new appointment to an existing ServiceTitan job, with start and end times and optional technicians. A job’s first appointment is created by Create Job; use this only for additional visits.

Input Parameters

string
required
End date-time of new appointment. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Start date-time of new appointment. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
ID of job for new appointment.
array
List of IDs of technicians to assign to new appointment.
string
Arrival window end date-time for new appointment, if configured. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Arrival window start date-time for new appointment, if configured. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Special instructions associated to the appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_ARRIVAL_WINDOWCreate a ServiceTitan arrival window with a start time and duration for a set of business units.

Input Parameters

string
required
Start time of the arrival window as a TimeSpan string, e.g. 09:00.
string
required
Documented as the end time for the arrival window defined as TimeSpan, e.g. 11:00, although the field is named duration. Which of the two the API expects is unverified.
array
required
IDs of the business units this arrival window applies to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_BOOKINGCreate a booking in ServiceTitan, an incoming request that office staff later book as a job or dismiss. It does not create a job; send at least one phone or email in contacts so staff can follow up.

Input Parameters

string
required
Name of the customer.
string
Requested start time of the booking. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Where the booking came from, for example the name of the website or widget.
object
Address of the booking. When sent, street, city, state, zip and country are required.
string
required
Summary of the booking.
array
Contacts for the booking, each with type and value.
string ("Low" | "Normal" | "High" | "Urgent")
Booking priority.
integer
ID of the booking’s campaign.
string
required
Your own id for the booking. Required; it can be used later to find the booking with the external_id filter.
integer
ID of the booking’s job type.
string ("Residential" | "Commercial")
Type of customer: Residential or Commercial.
array
Images attached to the booking, as a list of strings. The spec does not say whether these are URLs or file names.
integer
ID of the booking’s business unit.
integer
required
Id of the booking provider tag this connection was granted, from LIST_BOOKING_PROVIDER_TAGS.
boolean
required
Whether this is a first-time client.
boolean
Set true to send the customer a confirmation email when the booking is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_BOOKING_CONTACTAdd a contact entry (phone, email or fax) to a booking in ServiceTitan for a given booking provider. This is the booking’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.

Input Parameters

string
Short note about this contact entry, for example ‘work number’.
string ("Phone" | "MobilePhone" | "Email" | "Fax")
required
Type of contact entry: Phone, MobilePhone, Email or Fax.
string
required
The phone number, email address or fax number.
integer
required
Id of the booking.
integer
required
Id of the booking provider tag this connection was granted, from LIST_BOOKING_PROVIDER_TAGS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_BOOKING_PROVIDER_TAGCreate a booking provider tag in ServiceTitan, the label that identifies one source of bookings. Both tag_name and description are required.

Input Parameters

string
required
Name of the booking provider tag.
string
required
Description of the booking provider tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_BUDGET_CODECreate a full ServiceTitan budget code from a list of segment item IDs. Use Create Partial Budget Code when some segments have no item chosen.

Input Parameters

array
required
IDs of the segment items that make up the budget code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_BUSINESS_HOURSSet the ServiceTitan business hours by sending the open time ranges for weekdays, Saturday and Sunday. All three lists are required; whether this replaces existing hours is not documented.

Input Parameters

array
required
Open time ranges for Sunday.
array
required
Open time ranges for Saturday.
array
required
Open time ranges for weekdays.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_CAMPAIGNCreate a marketing campaign in ServiceTitan. name, business_unit_id, category_id and active are required.

Input Parameters

string
Tracking phone number (DNIS) of the campaign. Calls to this number are attributed to the campaign.
string
required
Name of the campaign.
boolean
required
Whether the campaign is active.
string
Marketing medium of the campaign. Accepted values are not documented.
string
Traffic source of the campaign. Accepted values are not documented.
integer
required
Id of the campaign category, from LIST_CAMPAIGN_CATEGORIES.
string
Free-text medium label. How it relates to medium is not documented.
string
Free-text source label. How it relates to source is not documented.
integer
required
Id of the business unit the campaign belongs to.
boolean
Set true to make this the default campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_CAMPAIGN_CATEGORYCreate a marketing campaign category in ServiceTitan. Returns only the new category’s id.

Input Parameters

string
required
Name of the campaign category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_CAMPAIGN_COSTCreate the cost record of a marketing campaign for one month in ServiceTitan. The amount is given as a daily cost, not a monthly total.

Input Parameters

integer
required
Calendar year of the cost record, e.g. 2025.
integer
required
Month of the cost record, 1 to 12.
number
required
Cost per day for that month, as a decimal amount.
integer
required
Id of the campaign the cost belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_CONTACTCreate a contact (a person record with name and title) in ServiceTitan. It is not linked to anything yet; add phone or email with CREATE_CONTACT_METHOD and link it with CREATE_CONTACT_RELATIONSHIP.

Input Parameters

string
Name of the contact.
string
Title of the contact.
string
External reference ID of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_CONTACT_METHODAdd a contact method (phone, mobile phone, email or fax) to a contact in ServiceTitan. contact_id is the GUID of a person contact from CREATE_CONTACT or LIST_CONTACTS; to add a phone or email directly to a customer, location or booking use CREATE_CUSTOMER_CONTACT, CREATE_LOCATION_CONTACT or CREATE_BOOKING_CONTACT.

Input Parameters

string
Short note about this contact method, for example ‘work number’.
string ("Phone" | "Email" | "Fax" | "MobilePhone")
required
Type of the contact method.
string
required
The phone number, email address or fax number.
string
required
GUID of the contact, from LIST_CONTACTS.
string
Reference ID of the contact method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_CONTACT_RELATIONSHIPLink a contact to a customer, location or booking in ServiceTitan. All three values go in the path and no request body is sent.

Input Parameters

string
required
GUID of the contact, from LIST_CONTACTS.
Id of the customer, location or booking on the other side of the relationship.
string ("customer" | "location" | "booking")
required
What the contact is linked to: customer, location or booking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_CUSTOMERCreate a customer in ServiceTitan together with its first location or locations. name, address and at least one entry in locations are required; merging or deactivating customers is not available through the API.

Input Parameters

string
required
Name of the customer.
string ("Residential" | "Commercial")
Type of customer.
object
required
Bill-To address of the customer record.
array
Contacts for the customer.
array
required
Locations to create with the customer, at least one. Each needs name and address.
boolean
Whether the customer is tax exempt.
boolean
Customer has been flagged as “do not mail”.
number
Credit Limit for the customer.
array
Ids of the tag types to associate with the customer.
array
Custom field values of the customer, each with typeId and value.
object
External data items to attach to this customer.
boolean
Customer has been flagged as “do not service”.
integer
Id of the customer’s payment term.
boolean
Customer has been flagged as National Account.
number
Credit Limit Balance for the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_CUSTOMER_CONTACTAdd a contact entry (phone, mobile phone, email or fax) to a customer in ServiceTitan. It is not copied to the customer’s locations. This is the customer’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.

Input Parameters

string
Short description about this contact, for example, “work #” or “Owner’s daughter - Kelly”.
string ("Phone" | "Email" | "Fax" | "MobilePhone")
required
Type of contact entry: Phone (landline), MobilePhone, Email or Fax.
string
required
The email, phone number, or fax number for the contact.
integer
required
Id of the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_CUSTOMER_NOTEAdd a note to a customer in ServiceTitan. Set add_to_locations to copy the same note to the customer’s active locations.

Input Parameters

string
required
Text content of customer note.
boolean
Whether to pin customer note to the top.
integer
required
Id of the customer.
boolean
Whether to add the same note to the customer’s active locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_EMPLOYEECreate an office employee in ServiceTitan with a role and positions; returns the new employee id. account_creation_method picks CreateLater, SendInvite or AssignLoginAndPassword; the spec does not describe what each one does.

Input Parameters

string
required
Employee name.
string
required
Email.
string
Login (Username).
integer
required
User role Id.
string
Login password of the new user. Sensitive. The spec does not say which account_creation_method needs it.
array
required
List of company positions.
string
Azure Active Directory User Id.
string
Office phone.
array
List of employee’s custom fields, each with typeId and value.
integer
Business unit Id.
string
Mobile phone.
string ("CreateLater" | "SendInvite" | "AssignLoginAndPassword")
required
How the login is set up: CreateLater, SendInvite or AssignLoginAndPassword. The spec names the methods but does not describe their effect.
array
Business Unit Access IDs. Requires ‘Business units filtering for employees’ feature flag, otherwise HTTP 400.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_EQUIPMENT_SYSTEMCreate an equipment system at a ServiceTitan customer location, optionally attaching installed equipment to it. The name must be unique within the location.

Input Parameters

string
Optional free-text memo.
string
required
The display name of the equipment system. Must be unique within the location.
integer
required
The location at which the new equipment system lives.
array
Optional tag type IDs to associate with the new system.
array
Optional custom field values, each with id, typeId and value.
array
Optional existing installed equipment IDs to attach to the new system at creation time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_EQUIPMENT_TYPECreate an equipment type in ServiceTitan for classifying installed equipment.

Input Parameters

string
required
Equipment type name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_ESTIMATECreate an estimate in ServiceTitan on a job or project, with its line items. Use it to quote work before it is sold; every field is optional in the spec, and which ones ServiceTitan actually needs (such as job_id or project_id) is not documented.

Input Parameters

number
Tax amount on the estimate.
string
Name of the estimate.
array
Line items of the estimate, each a pricebook service, material or equipment. Nested keys use the documented spelling (skuId, unitPrice).
integer
Id of the job the estimate belongs to.
string ("Open" | "Sold" | "Dismissed")
Estimate status: Open, Sold or Dismissed.
string
Summary text shown on the estimate.
integer
Id of the project the estimate belongs to.
integer
Id of the technician credited with the sale.
integer
Id of the service location the estimate is for.
string ("None" | "NeedsApproval" | "Approved" | "NotApproved")
Review status: None, NeedsApproval, Approved or NotApproved.
integer
Id of the budget code the estimate is booked against.
number
Deposit requested, as a fixed amount.
Links to external documents shown with the estimate.
Whether this estimate is the recommended option for the customer.
number
Deposit requested, as a percentage of the estimate total.
boolean
Whether to apply the project’s default labels to the estimate.
boolean
Whether the deposit must be paid when the customer signs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_ESTIMATE_TEMPLATECreate an estimate template in ServiceTitan from a list of pricebook items. Static templates need a unitPrice on every item; Dynamic templates take prices from the pricebook.

Input Parameters

string ("Dynamic" | "Static")
required
Pricing mode: Static (prices fixed on the template, unitPrice needed on every item) or Dynamic (prices computed from the pricebook).
string
required
Customer-facing name of the estimate template.
array
required
Items of the template. skuId, skuType, quantity and isAddOn are required on each item.
boolean
Whether the template is active.
string
Summary text of the template.
string
required
Internal name of the estimate template, shown to staff.
integer
Id of the business unit the template belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_EXTERNAL_CALL_ATTRIBUTIONAttribute a phone call tracked by outside call-tracking software to a web session in ServiceTitan Marketing Ads. It records attribution only; it does not create a call, lead or job.

Input Parameters

object
required
The web session to attribute to. landingPageUrl and referrerUrl are required; click ids (gclid, fbclid, msclkid and others) and UTM values are optional.
object
required
The tracked call: customerPhoneNumber, forwardingPhoneNumber, trackingPhoneNumber and callStartedOnUtc are all required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_FINDINGCreate a finding in ServiceTitan to record an issue or observation at a customer location, with an urgency level and optional links to installed equipment and the job where it was found. Attachments link file URLs; no file content is uploaded.

Input Parameters

string
Title summarizing the issue or observation (e.g., “Leaking pipe”, “Worn brake pads”).
array
Photos, videos, or documents supporting the finding, each with fileName, url and type. No file content is sent.
string
Detailed description of the issue, condition, or observation.
integer
required
ID of the customer location where the finding was identified.
integer
ID of the job during which this finding was discovered (optional).
string ("NotSpecified" | "Low" | "Medium" | "High" | "Critical")
required
Priority level indicating how urgently the finding should be addressed.
string
Private notes for internal use, not visible to customers.
Suggested action or repair to address the finding.
integer
ID of the specific equipment where the finding was observed (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_FINDING_ATTACHMENTAdd an attachment to a ServiceTitan finding by linking a file URL with a file name and media type. No file content is sent; the spec expects the URL returned by ServiceTitan’s findings upload endpoint, which is not available as a tool.

Input Parameters

string
required
URL of the uploaded file obtained from ServiceTitan’s findings upload endpoint, which is not available as a tool; whether other URLs are accepted is undocumented.
string ("Other" | "Image" | "VideoFile" | "VideoLink" | "Document")
required
Media type of the attachment.
string
required
Original file name (e.g., “motor-inspection.jpg”).
integer
required
Id of the finding that owns the attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_GL_ACCOUNTCreate a general ledger (GL) account in ServiceTitan and return the created account. At least one account field must be supplied with a non-null value.

Input Parameters

string
Account name.
string
Account type name; see LIST_GL_ACCOUNT_TYPES.
string
Account number.
string
Account subtype.
string
Account description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_GPS_PINGSSend GPS location pings for technician vehicles or units to ServiceTitan for a configured GPS provider, so they plot on the Dispatch Map. Returns a per-ping result; a ping can fail while the call succeeds.

Input Parameters

array
required
One or more GPS pings to send. At least one GPS ping is required.
string
required
Name of the GPS provider, as configured for the tenant under Settings > Integrations > GPS and selected when the app was connected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_GROSS_PAY_ITEMCreate a gross pay item inside an existing payroll in ServiceTitan and return its id. payroll_id, amount, activity_code_id and date are required; find the payroll id with LIST_PAYROLLS.

Input Parameters

string
required
Date of the gross pay item. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Memo of the gross pay item.
number
required
Amount of the gross pay item.
integer
Id of the invoice.
integer
required
Id of the payroll the item belongs to; see LIST_PAYROLLS.
integer
Id of the budget code.
integer
required
Id of the payroll activity code; see LIST_PAYROLL_ACTIVITY_CODES.
integer
Id of the business unit to use as the payout business unit. If not provided, the default applies: the employee or technician business unit when no invoice is set, the invoice business unit when one is.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_INSTALLED_EQUIPMENTCreate a record of equipment installed at a ServiceTitan customer location, with serial number, warranty dates, and an optional parent equipment or system. Only location_id is required.

Input Parameters

number
Cost of the equipment.
string
Free-text memo.
string
Name of the installed equipment.
string
Model name or number.
object
Parent of this equipment: another installed equipment record or an equipment system, given by id and type.
string ("Installed" | "Replaced")
Whether the equipment is currently installed or has been replaced.
string
Barcode identifier of the equipment.
array
Files to link to the equipment, each by URL with its type.
integer
required
Id of the customer location where the equipment is installed.
string
When the equipment was installed. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Manufacturer name.
array
Ids of the tag types to apply.
array
Custom field values to set, each with typeId and value.
string
Serial number of the equipment.
string
Date the equipment was manufactured. Date, e.g. 2025-01-31.
integer
Id of the equipment type; see LIST_EQUIPMENT_TYPES.
string
Date the equipment was actually replaced. Date, e.g. 2025-01-31.
string
End of the manufacturer warranty. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Start of the manufacturer warranty. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
End of the service provider warranty. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Start of the service provider warranty. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_INVENTORY_ADJUSTMENTCreate an inventory adjustment in ServiceTitan that changes stock quantities at one inventory location. Only the types Adjustment, BeginningBalance, and Consignment can be created; item quantities may be negative.

Input Parameters

string
Adjustment date. Defaults to today (tenant time) when omitted. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Memo of the inventory adjustment.
string ("Adjustment" | "BeginningBalance" | "Consignment")
required
Adjustment type. Only manually-creatable types are accepted (Adjustment, BeginningBalance, Consignment).
array
Adjustment line items. Each needs skuId and quantity; quantity may be negative.
integer
required
Inventory location Id the adjustment posts against.
object
External data to attach to the created adjustment. applicationGuid and externalData are required.
integer
required
Business unit Id.
string
Reference number of the inventory adjustment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_INVENTORY_RECEIPTRecord a receipt of items against an existing ServiceTitan purchase order. items lists each SKU received with its quantity and cost.

Input Parameters

number
required
Receipt tax.
string
Receipt memo.
array
required
Purchase order items received. Each needs skuId, quantity and cost; purchaseOrderItemId names the purchase order line.
integer
Id of the job to associate with this receipt.
number
required
Receipt shipping cost.
string
required
Receipt date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the budget code.
integer
required
Id of the purchase order for this receipt.
string
Vendor document number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_INVENTORY_RETURNCreate a vendor return in ServiceTitan inventory, recording items sent back to a vendor from an inventory location.

Input Parameters

number
required
Tax rate of the vendor return, as the spec names it.
string
Memo or summary of the vendor return.
array
Line items returned. Each needs skuId, quantity and cost.
integer
Id of the job.
number
required
Shipping cost of the vendor return.
integer
required
Id of the vendor the items are returned to.
string
required
Return date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the budget code for the return.
number
required
Restocking fee of the vendor return.
integer
required
Id of the return type.
integer
required
Id of the business unit.
string
Reference number of the vendor return.
integer
Id of the purchase order.
integer
required
Id of the inventory location the items are returned from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_INVENTORY_RETURN_TYPECreate a vendor return type in ServiceTitan inventory, with its vendor-credit, sales-tax and default settings. Its id is the return_type_id that CREATE_INVENTORY_RETURN requires.

Input Parameters

string
required
Name of the return type.
boolean
required
Whether this is the default return type. The spec gives no description for this field.
boolean
required
Whether returns of this type are included in sales tax. The spec gives no description for this field.
boolean
required
Whether this is the default return type for consignment. The spec gives no description for this field.
boolean
required
Whether the return type allows receiving vendor credits automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_INVOICE_TASKCreate invoice workflow tasks in ServiceTitan from a required task template ID. The response includes the template execution status, created tasks and any execution errors.

Input Parameters

object
Template variables as name-value pairs of strings.
integer
required
Id of the invoice.
string
required
Id of the invoice task template to create the task from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_INVOICE_TEMPLATECreate a membership invoice template in ServiceTitan from a list of line items; returns the new template id. Memberships bill from these templates and recurring service jobs are invoiced from them.

Input Parameters

array
Line items of the invoice template. Each item needs skuId, quantity, unitPrice and isAddOn.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_JOBBook a new ServiceTitan job for a customer and location, with at least one appointment. Customer and location must already exist; the job’s first appointment is created from the appointments list.

Input Parameters

integer
ID of the Lead associated with this job.
string
Job summary. HTML is accepted.
string
required
Priority of the job. The list filter documents Low, Normal, High, Urgent.
boolean
Whether the job is a no-charge job.
integer
ID of the Booking that resulted in this job.
integer
ID of the job’s project.
integer
ID of the Technician who sold the job.
integer
required
ID of the job’s campaign.
integer
required
ID of the job’s customer.
string
Customer PO.
integer
required
ID of job type.
integer
required
ID of the job’s location.
array
required
List of appointment information. Each entry needs start and end; arrivalWindowStart, arrivalWindowEnd and technicianIds are optional.
array
List of IDs of tags on the job.
array
Custom fields on the job, each with typeId and value.
object
Optional model that contains a list of external data items that should be attached to this job. applicationGuid and externalData are required.
integer
ID of the job that this job is a recall for.
integer
required
ID of the job’s business unit.
integer
ID of the Call that 3rd-party agents are enabled to set.
object
Object that contains jobId, the ID of the job from which this job was generated, and employeeId, the ID of the office user or technician.
integer
ID of the Service Agreement visit that this job fulfills. When provided, the booked job is linked to the specified SA visit.
boolean
Whether the invoice requires a signature. When it is not sent, the rules of the location and the job type apply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_JOB_ATTRIBUTIONAttribute an existing job to a web session in ServiceTitan Marketing Ads. It records attribution only; the job must already exist.

Input Parameters

integer
required
Id of the job to attribute to the web session.
object
required
The web session to attribute to. landingPageUrl and referrerUrl are required; click ids (gclid, fbclid, msclkid and others) and UTM values are optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_JOB_NOTEAdd a note to a ServiceTitan job, optionally pinned to the top.

Input Parameters

string
required
Text content of job note.
integer
required
ID of the job.
boolean
Whether to pin job note to the top.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_JOB_TYPECreate a ServiceTitan job type with its name, priority, duration, business units, skills and default tags.

Input Parameters

string
required
Name of the job type.
array
List of skills required to complete this job.
string
Text that is automatically added to job summary when booked.
integer
Average length of time for this job type. The unit is not stated on this field; the list filter documents seconds.
string
Level of urgency for this type of job.
boolean
When true, all jobs are considered no charge.
array
Tags here will automatically be applied to jobs booked.
object
Optional model that contains a list of external data items that should be attached to this job type.
string
Class used to group job types.
number
A job is considered as converted if subtotal meets or exceeds this threshold.
array
Business Unit Ids associated with job type.
array
Custom field type IDs to assign to this job type. Order determines display order.
string
Default action when an estimate is sold for this job type.
boolean
When true signature is required.
boolean
When true enforce recurring service event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_JOURNAL_ENTRYCreate a journal entry with debit and credit lines in ServiceTitan; it is marked external automatically. status and version_id are required (the spec does not document what version_id a new entry should carry; unverified without a live account), and the documented response has no body, so the new id is not returned: find the entry with LIST_JOURNAL_ENTRIES.

Input Parameters

string
Name of the journal entry.
array
Journal entry lines; each needs debit and credit.
string ("Open" | "Closed")
required
Posting status of the journal entry: Open or Closed.
string
Message stored with the journal entry.
string
Posting date. Date in YYYY-MM-DD form, e.g. 2025-01-31.
integer
required
Version number of the journal entry. Required by the spec, which does not document what value a new entry should carry; unverified without a live account.
object
Custom fields as name-value pairs of strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_LABOR_TYPECreate a payroll labor type in ServiceTitan and return its id. name, code and active are all required.

Input Parameters

string
required
Code for the payroll labor type.
string
required
Name of the payroll labor type.
boolean
required
Whether the payroll labor type is active. The spec lists this field as required, so it is always sent.
integer
Id of the labor SKU (service) to map this labor type to. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_LEADCreate a lead in ServiceTitan. campaign_id and summary are required, and one of call_reason_id or follow_up_date must be sent; passing booking_id irreversibly dismisses that booking and turns it into this lead; ServiceTitan documents no operation to undo the dismissal. For a web-form style lead with just a name and contact details and no campaign id, use SUBMIT_LEAD_FORM.

Input Parameters

string
required
Lead summary.
string
Zip provided for the lead.
string ("Low" | "Normal" | "High" | "Urgent")
Priority of the lead.
string
City provided for the lead.
string
Unit provided for the lead.
integer
The associated Booking Id to use for creating the Lead. This Booking will be dismissed and a Lead will get created associated to this Booking.
string
Email provided for the lead.
string
Phone number provided for the lead.
string
State provided for the lead.
integer
required
ID of the campaign.
integer
ID of the customer.
integer
ID of job type.
string
Street provided for the lead.
integer
ID of the location.
string
Country provided for the lead.
array
List of IDs of tags on the lead.
integer
ID of the call reason. Required if follow up date is not provided.
string
Date of when to follow up. Required if call reason ID is not provided. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
ID of the business unit.
string
Customer name provided for the lead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_LEAD_FOLLOW_UPSchedule a follow-up on a lead in ServiceTitan by setting the next follow-up date, with an optional note.

Input Parameters

string
Text of follow-up note.
integer
required
Id of the lead.
boolean
Whether to pin follow-up note to the top.
string
required
Follow-up date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_LEAD_NOTEAdd a note to a lead in ServiceTitan.

Input Parameters

string
required
Text content of lead note.
integer
required
Id of the lead.
boolean
Whether to pin lead note to the top.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_LOCATIONCreate a location (service address) in ServiceTitan under an existing customer. name, address and customer_id are required.

Input Parameters

string
required
Name of the location.
object
required
Address of the location record.
array
Contacts for the location.
integer
required
ID of the location’s customer.
integer
Optional tax zone id to use for the location. When provided, this tax zone is used instead of being automatically resolved from the location’s address.
array
Tag type ids for the location.
array
Custom field values of the location, each with typeId and value.
object
Optional model that contains a list of external data items that should be attached to this Location.
string ("None" | "System" | "User" | "Imported")
Where the address coordinates came from.
string ("Unverified" | "InProgress" | "Failed" | "Verified")
Verification status of the address coordinates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_LOCATION_CONTACTAdd a contact entry (phone, mobile phone, email or fax) to a location in ServiceTitan. The provider guide says an entry added to a new location is also copied to its customer. This is the location’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.

Input Parameters

string
Short description about this contact, for example, “work #” or “Owner’s daughter - Kelly”.
string ("Phone" | "Email" | "Fax" | "MobilePhone")
required
Type of contact entry: Phone (landline), MobilePhone, Email or Fax.
string
required
The email, phone number, or fax number for the contact.
integer
required
Id of the location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_LOCATION_NOTEAdd a note to a location in ServiceTitan. Set add_to_customer to copy the same note to the location’s customer.

Input Parameters

string
required
Text content of location note.
boolean
Whether to pin location note to the top.
integer
required
Id of the location.
boolean
Whether to add the same note to the location’s customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_MEMBERSHIP_SALE_INVOICESell a membership to a customer in ServiceTitan by creating a membership sale invoice; returns the new invoice id and customer membership id. It creates a real invoice and membership together, so call it only once the sale is confirmed. Setting recurring_service_action=None deletes the customer’s existing recurring services.

Input Parameters

integer
required
ID of the customer you are creating the Membership Sale Invoice for.
integer
Discount location ID of this membership. Leave out for all locations (the spec documents null as all locations).
integer
required
ID of the sale task that is creating the membership.
integer
required
Business unit ID.
integer
required
ID of the duration/billing option to be used.
integer
The location at which recurring services are scheduled. Leave out for all locations (the spec documents null as all locations).
string ("None" | "Single" | "All")
required
How many of the customer’s locations get the recurring services: All, Single, or None. None deletes existing recurring services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_NON_JOB_APPOINTMENTBlock time on a ServiceTitan technician’s schedule for a non-customer activity such as a meeting, training or time off, optionally repeating. For a customer visit use Create Appointment.

Input Parameters

string
required
Name of the non-job appointment, for example Training.
string
required
Start of the non-job appointment. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Date-time the repetition ends, used when end_type is On. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Whether the non-job appointment repeats.
boolean
Whether the non-job appointment lasts the whole day.
string
Free-text summary of the non-job appointment.
string
required
Length of the non-job appointment as a TimeSpan string such as 02:00:00.
string ("Never" | "After" | "On")
How the repetition ends: Never, After a number of occurrences, or On a date.
integer
Repeat every N units of frequency.
string ("Daily" | "Weekly" | "Monthly" | "Yearly")
How often the non-job appointment repeats.
string
Days of the week the appointment repeats on. The string format is not documented.
integer
required
ID of the technician whose time is blocked.
integer
Number of occurrences, used when end_type is After.
integer
ID of the timesheet code that identifies how this time is paid.
boolean
Whether to clear this time on the dispatch board. Meaning taken from the field name; not documented.
boolean
Whether to clear this time in the technician’s view. Meaning taken from the field name; not documented.
boolean
Whether the non-job appointment shows on the technician’s schedule even if there is no timesheet.
boolean
Whether the technician is left out of capacity planning for this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_OPT_OUTSOpt one or more phone numbers out of contact in ServiceTitan and return a result for each number. The whole request fails if any number cannot be parsed, and a number already opted out globally cannot be opted out for marketing.

Input Parameters

string ("Unknown" | "Global" | "Marketing" | "Other")
required
Type of opt-out to create: Global, Marketing, Other or Unknown.
array
required
Phone numbers to act on; at least one. Each must be a valid phone number, E.164 format such as +15551234567 recommended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PARTIAL_BUDGET_CODECreate a partial ServiceTitan budget code from segment bindings, where a segment may be left without an item. Use Create Budget Code when every segment has an item.

Input Parameters

array
required
Segment bindings that make up the budget code: one entry per segment, with or without an item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PAYROLL_ADJUSTMENTCreate a payroll adjustment, a manual earning or deduction for one employee or technician, in ServiceTitan and return its id. employee_type must match the kind of id given in employee_id.

Input Parameters

string
Memo of the payroll adjustment.
number
Rate of the payroll adjustment.
number
Hours of the payroll adjustment.
number
The payroll adjustment amount.
number
Quantity of the payroll adjustment.
string
required
When the adjustment is posted. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the payroll adjustment invoice.
integer
required
Id of the employee or technician the adjustment is for.
string ("Technician" | "Employee")
required
Whether employee_id refers to a Technician or an Employee.
integer
Id of the payroll adjustment activity code.
integer
Id of the payroll adjustment business unit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PRICEBOOK_CATEGORYCreate a category in the ServiceTitan pricebook, as a Services or Materials category. Set parent_id to create it as a subcategory.

Input Parameters

string
required
The name of the category.
string
The image to display as the category.
boolean
Active shows if this category is currently active.
integer
The position location of this item.
integer
The id of the category that is the parent of this item. Set it to create the category as a subcategory.
array
The images that will be used for the SKUs under this category.
array
The videos that will be used for the SKUs under this category.
string
A description that described the category.
string ("Services" | "Materials")
required
The category type: Services or Materials.
array
Ids of the business units that are associated with this category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PRICEBOOK_DISCOUNT_OR_FEECreate a discount or a fee in the ServiceTitan pricebook. The type field decides which one, and amount_type decides whether the amount is a percentage or a fixed value.

Input Parameters

string
required
Code of the discount or fee.
string ("Discount" | "Fee")
required
Discount or Fee: which kind of item this is.
number
Flat-rate bonus paid for this item.
number
Number of hours associated with the item.
number
Maximum amount that can be applied for this item.
boolean
Whether the item is active.
number
required
Percentage or flat amount to discount or add, as amount_type says.
array
Images, videos or PDFs to attach to the item. Each needs type and url.
string
Accounting account assigned to the item.
boolean
Set true to apply tax when the item is added to an estimate or invoice.
array
Ids of the categories technicians use to find the item.
string ("Percentage" | "Fixed")
required
Percentage or Fixed: whether amount is a percentage or a flat amount.
string
required
Description of the item. The spec gives its format as html.
string
Display name of the discount or fee.
object
External data to attach to the item: applicationGuid and an externalData list of key/value pairs, both required.
boolean
Whether this item pays commission.
string
Budget cost code segment. Send budget_cost_type with it.
string
Budget cost type segment. Send budget_cost_code with it.
number
Percentage-rate bonus paid for this item.
string
Cross-sale group, tracked as a separate column on the Technical Performance Board.
boolean
Set true to let users enter a custom amount when applying this item.
boolean
Whether the item is excluded from payroll.
string
Intacct GL group name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PRICEBOOK_EQUIPMENTCreate an equipment item in the ServiceTitan pricebook catalog, with pricing, warranty, vendors, and categories. This does not record equipment installed at a location; use CREATE_INSTALLED_EQUIPMENT for that.

Input Parameters

string
required
Code of the item.
number
Cost paid to acquire the item.
number
Flat-rate bonus paid for the item.
number
Number of hours to install the equipment.
string
Model of the equipment.
number
Sale price of the item.
boolean
Whether the item is active.
array
Images, videos or PDFs to attach to the item. Each needs type and url.
string
Accounting account assigned to the item.
boolean
Whether the item is taxable.
array
Ids of upgrades that can be sold for this item.
array
Ids of the categories the item belongs to.
object
Dimensions of the equipment: height, width and depth.
string
required
Description displayed with the item. The spec gives its format as html.
number
Price when the item is sold as an add-on.
string
Name displayed with the item.
boolean
Whether the equipment is part of inventory.
string
Name of the manufacturer.
number
Price when the item is sold to a member.
string
Name of the asset general ledger account for the item.
object
External data to attach to the item: applicationGuid and an externalData list of key/value pairs, both required.
array
Other vendors the item can be acquired from. Each needs vendorId, cost and active.
boolean
Whether the cost is locked from editing.
object
Primary vendor the item is acquired from. vendorId, cost and active are required.
boolean
Whether the price is locked from editing.
boolean
Whether the item pays commission.
array
Services and materials recommended with this item, each with skuId and type (Service or Material).
string
Unit of measure of the item.
string
Budget cost code segment. Send budget_cost_type with it.
string
Budget cost type segment. Send budget_cost_code with it.
number
Percentage-rate bonus paid for the item.
string
Cross-sale group, tracked as a separate column on the Technical Performance Board.
number
Price when the item is sold to a member as an add-on.
array
Materials used with this equipment, each with skuId and quantity.
array
Ids of the variation items to add.
string
Name of the cost of sale general ledger account for the item.
object
Manufacturer warranty included with the item: duration (required) and description.
string
Intacct GL group name.
boolean
Whether the item is configurable equipment.
object
Service provider warranty included with the item: duration (required) and description.
boolean
Whether the estimated cost is left off the invoice when carried over from an estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PRICEBOOK_MATERIALCreate a material in the ServiceTitan pricebook, with cost, pricing, vendors, and categories. Only code and description are required.

Input Parameters

string
required
Code for the SKU.
number
The cost paid to acquire the material.
number
Flat-rate bonus paid for this task.
number
The number of hours associated with installing the material.
number
Price of this SKU when sold.
boolean
Whether the SKU is active.
array
Images, videos or PDFs attached to the SKU, each with type and url.
string
The accounting account assigned to this SKU.
boolean
Whether this SKU is taxable.
array
Ids of the categories this SKU belongs to.
string
Optional EPA registration number, up to 500 characters, when is_chemical is true.
string
required
Description on the SKU that is displayed with the item. It can contain HTML.
boolean
When true, an EPA number and active ingredients may be recorded for this chemical material.
number
The price if the SKU is sold as an add-on item.
integer
Id of the cost type of the other direct cost.
string
Name that displays with the SKU.
boolean
Whether this material is part of your inventory.
number
The price if the item is sold to a member.
string
Name of the asset general ledger account for this item.
object
External data items to attach to this material, under one application GUID.
array
Other vendors that you might go to acquire this SKU, each with vendorId, cost and active.
boolean
Whether the cost is locked from editing.
object
The primary vendor you use to acquire this SKU. vendorId, cost and active are required inside it.
boolean
Whether the price is locked from editing.
boolean
Whether this task pays commission.
string
The unit of measure used for this SKU.
string
The budget cost code segment for this material. budget_cost_type should also be provided.
string
The budget cost type segment for this material. budget_cost_code should also be provided.
number
Percentage-rate bonus paid for this task.
string
Optional active ingredients, up to 500 characters, when is_chemical is true.
boolean
Whether this is deducted as a job cost.
number
The price if the SKU is sold to a member as an add-on item.
array
Ids of the variation materials to add.
string
Name of the cost of sale general ledger account for this item.
boolean
Whether this is an other direct cost. False by default.
boolean
Whether this is chargeable by default.
string
Intacct GL group name.
boolean
Whether this is a configurable material.
boolean
Whether the estimated cost is excluded from the invoice when carried over from an estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PRICEBOOK_MATERIAL_MARKUPCreate a material markup tier in the ServiceTitan pricebook: a from/to range and the markup percent applied to it. The documented body also requires an id value.

Input Parameters

integer
required
Required by the spec’s create body. Send 0 for a new tier, as the spec’s example body does; ServiceTitan’s handling of other values is undocumented.
number
required
Markup percent applied within the range.
number
required
Upper bound of the material cost range this markup tier applies to.
number
required
Lower bound of the material cost range this markup tier applies to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PRICEBOOK_SERVICECreate a service in the ServiceTitan pricebook, with pricing, warranty, categories, and linked materials and equipment. Only code and description are required.

Input Parameters

string
required
Code for the SKU.
number
Flat rate bonus paid for this task.
number
Hours needed to complete this service.
number
Price of this SKU sold.
boolean
Active shows if the SKU is active or inactive.
array
Images, videos or PDFs attached to SKU.
string
The accounting account assigned to this SKU.
boolean
Is this SKU taxable.
boolean
Is a labor service.
array
Ids of the upgrades that can be sold for this service.
object
Description of the warranty included in this SKU.
array
Ids of the categories the service belongs to.
string
required
Description on the SKU that is displayed with the item.
number
The price of the SKU is sold as an add-on item.
string
Name that displays with the SKU.
number
The price if the item is sold to a member.
object
External data to attach to the service: applicationGuid and an externalData list of key/value pairs, both required.
boolean
Whether the price is locked from editing.
boolean
True if this task pays commission.
array
Ids of the services and materials recommended with this service.
string
The Budget CostCode segment for this entity. (Note: BudgetCostType should also be provided).
string
The Budget CostType segment for this entity (Note: BudgetCostCode should also be provided).
number
Percentage rate bonus paid for this task.
string
A grouping of similar items that you’ll then be able to track as a separate columns on the Technical Performance Board.
array
Array of equipment linked to the service.
array
Array of materials linked to the service.
number
The price if the SKU is sold to a member as an add-on item.
string
Intacct GL Group Name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PROJECTCreate a ServiceTitan project at a location to group related jobs. Only the location is required; jobs are added afterwards with Attach Job To Project.

Input Parameters

string
Project name.
string
Project summary. HTML is accepted.
integer
Project status id.
string
Start date of the project. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
ID of the project’s customer.
integer
required
ID of the project’s location.
array
Project record’s custom fields.
object
Optional model that contains a list of external data items that should be attached to this project.
integer
Project sub status id.
integer
ID of the project’s type.
array
IDs of business units for the project.
array
IDs of the project’s managers.
string
Actual completion date of the project. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Target completion date of the project. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PROJECT_NOTEAdd a note to a ServiceTitan project, optionally pinned to the top.

Input Parameters

string
required
Text content of the project note. Must not be empty.
boolean
Whether to pin job note to the top.
integer
required
ID of the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PROPOSAL_TEMPLATECreate a proposal template in ServiceTitan that assigns an estimate template to each option of a proposal type. Each proposal type option may appear only once in estimate_assignments.

Input Parameters

string
required
Name of the proposal template.
boolean
Whether the template is active.
string ("Publish" | "Draft")
Publication status: Publish or Draft.
string
Description of the proposal template.
integer
required
Id of the proposal type the template belongs to, from the proposal types list.
array
Ids of the business units the template is available to.
array
required
Maps proposal type options to estimate templates, each with proposalTypeOptionId, estimateTemplateId and order. Each proposalTypeOptionId must be unique within the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PURCHASE_ORDERCreate a purchase order in ServiceTitan for items ordered from a vendor. vendor_id, type_id, business_unit_id and inventory_location_id name existing records, and only the id of the new purchase order is returned.

Input Parameters

number
required
Tax of the purchase order.
string
required
Date of the purchase order. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Summary or memo for this purchase order.
array
required
Items of the purchase order.
integer
Id of the job for this purchase order. When omitted, a non-job purchase order is created.
object
required
Address the purchase order is shipped to: description and address.
integer
required
Id of the purchase order type for this purchase order.
number
required
Shipping cost of the purchase order.
integer
required
Id of the vendor for this purchase order.
integer
Id of the project for this purchase order.
string
required
Date the purchase order is required on. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the technician for this purchase order.
integer
Id of the budget code for this purchase order.
integer
required
Id of the business unit for this purchase order.
integer
required
Id of the inventory location for this purchase order.
string
Vendor invoice number. Provide it for auto-received purchase orders.
boolean
required
Whether this purchase order impacts the technician’s payroll.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PURCHASE_ORDER_MARKUPCreate a purchase order markup tier in ServiceTitan: a from/to range and the markup percent applied to it.

Input Parameters

number
required
Markup percent applied within the range.
number
required
Upper bound of the range this markup tier applies to.
number
required
Lower bound of the range this markup tier applies to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_PURCHASE_ORDER_TYPECreate a purchase order type in ServiceTitan, with its receiving, tax, payroll, and alert settings. Most settings are required, not optional.

Input Parameters

string
required
Name of the Purchase Order Type.
boolean
required
Whether the purchase order type is active.
boolean
required
Whether this type is the default purchase order type.
boolean
required
Whether weekends are skipped when the default required date is calculated.
object
required
Alert definition for the Purchase Order Type. All four email flags are required.
string ("None" | "ByValue")
Landed cost method for this PO type: None or ByValue.
boolean
required
Whether the type is included in the Purchase Order screen.
boolean
required
Whether the purchase order total is included in the sales tax calculation.
boolean
required
Whether purchase orders of this type are received automatically.
boolean
required
Whether the type is shown to technicians on mobile.
boolean
When enabled, once a Job is set on a PO of this type it cannot be cleared.
boolean
required
Whether this type is the default for consignment.
boolean
required
Whether a job must be set before a purchase order of this type is received.
boolean
required
Allow permitted technicians to send and receive POs of this type.
boolean
required
Whether tax on purchase orders of this type is excluded from job costing.
boolean
required
Default Selection for Impact to Technician Payroll on Purchase Order.
boolean
Whether to include tax in fully landed cost.
integer
required
Default number of days to offset required date.
boolean
required
Whether the items are copied to the invoice when the purchase order is received.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_SUBTASKCreate a subtask under an existing task in ServiceTitan Task Management, assigned to an employee. The documented response has no subtask id; it returns parent_task_id and subtask_number.

Input Parameters

string
required
Title of the subtask.
integer
required
Id of the parent task.
boolean
required
Whether the subtask is created already closed. Send false for a new open subtask.
string
Due date of the subtask. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
Id of the employee the subtask is assigned to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_TAG_TYPECreate a tag type in ServiceTitan with a name and a hex color; returns the new tag type id. Keep the name to 30 characters or fewer.

Input Parameters

string
Code associated with the tag type, at most 20 characters.
string
required
Name of the tag type. The ServiceTitan guide asks for 30 characters or fewer; the spec sets no limit.
string
required
Color of the tag type as a 6-digit hex string, for example #FF0000.
string ("Medium" | "High")
Importance of the tag type: Medium or High.
boolean
Whether tags of this type count as a sales opportunity.
boolean
Whether tags of this type are shown on the dispatch board.
boolean
Whether tags of this type may be used on timesheet activities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_TASKCreate an office task in ServiceTitan Task Management, assigned to an employee. The type, source, business unit and employee ids come from GET_TASK_REFERENCE_DATA. These are Task Management tasks, not the invoice workflow tasks of CREATE_INVOICE_TASK / LIST_INVOICE_TASKS.

Input Parameters

string
required
Title of the task.
integer
Id of the job the task relates to.
string ("ToDo" | "InProgress" | "OnHold" | "Canceled" | "Completed")
Task status: ToDo, InProgress, OnHold, Canceled or Completed.
string ("Low" | "Normal" | "High" | "Urgent")
required
Task priority: Low, Normal, High or Urgent.
boolean
required
Whether the task is created already closed. Send false for a new open task.
integer
Id of the project the task relates to.
string
When work on the task started. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Due date of the task. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the customer the task relates to.
string
Full description of the task.
string
required
When the task was reported. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
Id of the employee the task is assigned to.
integer
required
Id of the employee who reported the task.
integer
required
Id of the business unit the task belongs to.
integer
required
Id of the task type, from the task management data.
array
Ids of other employees involved in the task.
integer
required
Id of the task source, from the task management data.
integer
Id of the task resolution, from the task management data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_TEAMCreate a ServiceTitan dispatch team with a name and active flag.

Input Parameters

string
Name of the team.
boolean
required
Whether the team is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_TECHNICIANCreate a field technician in ServiceTitan with a role, positions and license type; returns the new technician id. Get role_id from LIST_USER_ROLES.

Input Parameters

string
Biography, as HTML.
object
Home address. street and city are required when it is sent.
string
Memo, as HTML.
string
required
Technician name.
string
Email address.
string
Login (user name).
integer
required
Id of the user role, from LIST_USER_ROLES.
string
Login password for the new technician user. It is the new user’s password, not a credential of this connection.
array
Ids of all of the technician’s zones.
array
required
Company positions of the technician.
string
Team name (not the team id).
number
Daily revenue goal.
string ("AllScheduledDispatchedWorking" | "NextScheduledDispatchedWorking" | "DispatchedWorking" | "NextScheduledDispatchedWorkingToday" | "AllScheduledDispatchedWorkingToday" | "AllScheduledDispatchedWorkingFiveDays" | "NextScheduledDispatchedWorkingTodayTomorrow" | "AllScheduledDispatchedWorkingTodayTomorrow" | "Next2ScheduledDispatchedWorkingToday")
Upcoming appointment visibility.
string
Azure Active Directory user id.
number
Hourly burden rate.
string ("NonManagedTech" | "ManagedTech" | "ManagedInstaller")
required
License type.
integer
Id of the technician’s main zone.
string
Technician’s phone number.
array
Custom field values of the technician, each with typeId and value.
integer
Id of the business unit, from LIST_BUSINESS_UNITS.
array
Project label ids. Requires the ‘Budget vs Actual’ feature flag, otherwise HTTP 400.
string ("CreateLater" | "SendInvite" | "AssignLoginAndPassword")
required
How the login is set up: CreateLater (no login yet), SendInvite (sends an invitation) or AssignLoginAndPassword (uses login and password). The spec does not say which fields each method requires.
string ("AllJobs" | "LastThreeDays" | "LastSevenDays" | "LastMonth")
Appointment history visibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_TECHNICIAN_RATINGRecord a rating from 0 to 10 for a technician on a specific job in ServiceTitan. If that technician and job already have a rating, it is overwritten with the new score.

Input Parameters

integer
required
Id of the job the rating is tied to.
number
required
Rating from 0 to 10.
integer
required
Id of the technician being rated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_TECHNICIAN_SHIFTCreate a ServiceTitan shift (Normal, OnCall or TimeOff) for one or more technicians, optionally repeating daily or weekly. Returns the list of shifts created.

Input Parameters

string
required
When the shift ends. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Longer explanation of the shift.
string
required
When the shift begins. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Title of the shift.
string
Days to repeat the shift on, as one string. The documented example is ‘Monday, Wednesday, Friday’; the format is not described further.
string ("Normal" | "OnCall" | "TimeOff")
required
Type of shift.
string ("Never" | "Daily" | "Weekly")
required
How the shift repeats.
array
required
IDs of the technicians to create the shift for.
string
Date-time to stop repeating on. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Repeat every N days or weeks, according to repeat_type.
integer
Timesheet code ID of the shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_TECHNICIAN_SKILLCreate a new skill in ServiceTitan and assign it to one technician in the same call. To give a technician skills that already exist use Assign Technician Skills.

Input Parameters

string
required
Name of the skill.
boolean
required
Whether the skill is active.
integer
required
ID of the technician to assign the new skill to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_TIMESHEET_ACTIVITYCreate a timesheet activity, a block of recorded time for one employee or technician, in ServiceTitan and return its id. employee_id, employee_type, activity_type_id, start_time and tag_type_ids are required; end_time is optional.

Input Parameters

string
Memo or notes related to the activity.
integer
Id of the job associated with the activity.
string
End time of the activity. Optional. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the project associated with the activity.
string
required
Start time of the activity. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
Id of the employee associated with the activity.
number
Miles driven associated with the activity.
array
required
Ids of the tag types associated with the activity. Required by the spec; whether an empty list is accepted is not documented.
string ("Technician" | "Employee")
required
Type of the employee that employee_id refers to.
integer
Id of the labor type associated with the activity; see LIST_LABOR_TYPES.
string
Label of the project associated with the activity.
integer
Id of the appointment associated with the activity.
integer
Id of the budget code associated with the activity.
integer
required
Id of the activity type; see LIST_TIMESHEET_ACTIVITY_TYPES.
string
Name of the budget code associated with the activity.
integer
Id of the non-job event assignment associated with the activity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_TRUCKCreate a truck inventory location in ServiceTitan. warehouse_id and name are required.

Input Parameters

string
Memo of the truck.
string
required
Truck name.
integer
Id of the inventory template for this truck.
integer
required
Id of the warehouse for this truck.
object
External data items to attach to this truck. applicationGuid and externalData are required.
array
Ids of the technicians to associate with this truck.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_VENDORCreate an inventory vendor (supplier) in ServiceTitan. The vendor’s main address is required.

Input Parameters

string
Contact fax of the vendor.
string
Memo of the vendor.
string
required
Name of the vendor.
array
Tags of the vendor, each with tagTypeId.
string
Contact email of the vendor.
string
Contact phone of the vendor.
boolean
required
Whether the vendor is active.
object
required
Address of the vendor. street, unit, city, state, zip and country are all required.
number
required
Default tax rate.
string
Contact last name.
string
Contact first name.
object
External data items to attach to this vendor: applicationGuid and an externalData list of key and value.
string ("Manual" | "EmailAsExcel" | "EmailAsPdf" | "EmailAsPdfRollupView" | "Electronic" | "MarkAsSent" | "EmailAsExcelAndPdf" | "VendorPortal")
Default purchase order delivery method.
integer
Id of the payment term.
array
Contacts at the vendor who receive purchase order emails, each with name and email.
integer
Id of the remittance vendor.
boolean
required
Whether this vendor is used for truck replenishment.
string
Vendor QuickBooks item.
boolean
required
Whether purchase order creation on mobile is restricted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_WEB_BOOKING_ATTRIBUTIONAttribute an existing booking to a web session in ServiceTitan Marketing Ads. It records attribution only; the booking must already exist.

Input Parameters

integer
required
Id of the booking to attribute to the web session.
object
required
The web session to attribute to. landingPageUrl and referrerUrl are required; click ids (gclid, fbclid, msclkid and others) and UTM values are optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_WEB_LEAD_FORM_ATTRIBUTIONAttribute an existing lead captured from a web form to a web session in ServiceTitan Marketing Ads. It records attribution only; the lead must already exist.

Input Parameters

integer
required
Id of the lead, captured from a web form, to attribute to the web session.
object
required
The web session to attribute to. landingPageUrl and referrerUrl are required; click ids (gclid, fbclid, msclkid and others) and UTM values are optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_CREATE_ZONECreate a ServiceTitan dispatch zone from zip codes, cities, territory numbers, service days and business units.

Input Parameters

string
Name of the zone.
array
Zip codes assigned to the zone.
array
Cities assigned to the zone.
array
LOCN numbers assigned to the zone.
array
IDs of the service days assigned to the zone.
array
IDs of the business units assigned to the zone.
array
Territory numbers assigned to the zone.
boolean
Whether the service days option is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DEACTIVATE_EMPLOYEE_ACCOUNTDeactivate a ServiceTitan employee’s login account.

Input Parameters

integer
required
Id of the employee whose login account to deactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DEACTIVATE_ESTIMATE_TEMPLATEDeactivate an estimate template in ServiceTitan. The template is not removed: it becomes inactive and stops appearing in active-only lists.

Input Parameters

integer
required
Id of the estimate template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DEACTIVATE_PROPOSAL_TEMPLATEDeactivate a proposal template in ServiceTitan. The template is not removed and can be reactivated by updating it with active true.

Input Parameters

integer
required
Id of the proposal template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DEACTIVATE_TECHNICIAN_ACCOUNTDeactivate a ServiceTitan technician’s login account.

Input Parameters

integer
required
Id of the technician whose login account to deactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_APPOINTMENTDelete a ServiceTitan job appointment by ID. The API refuses to delete the only appointment on a job or one with timesheets; an individual appointment cannot be canceled, only deleted.

Input Parameters

integer
required
ID of the job appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_BOOKING_CONTACTRemove one contact entry from a booking in ServiceTitan for a given booking provider. The booking itself is kept.

Input Parameters

integer
required
Id of the booking.
integer
required
Id of the contact entry, from the matching contacts list tool. This is a numeric id, not a contact GUID.
integer
required
Id of the booking provider tag this connection was granted, from LIST_BOOKING_PROVIDER_TAGS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_CONTACTDelete a contact in ServiceTitan by its GUID. To keep the record but hide it, set is_archived with UPDATE_CONTACT instead.

Input Parameters

string
required
GUID of the contact, from LIST_CONTACTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_CONTACT_METHODDelete one contact method from a contact in ServiceTitan. contact_id is the GUID of a person contact from CREATE_CONTACT or LIST_CONTACTS; to add a phone or email directly to a customer, location or booking use CREATE_CUSTOMER_CONTACT, CREATE_LOCATION_CONTACT or CREATE_BOOKING_CONTACT.

Input Parameters

string
required
GUID of the contact, from LIST_CONTACTS.
string
required
GUID of the contact method, from LIST_CONTACT_METHODS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_CONTACT_RELATIONSHIPRemove the link between a contact and a customer, location or booking in ServiceTitan. The contact itself is kept.

Input Parameters

string
required
GUID of the contact, from LIST_CONTACTS.
Id of the customer, location or booking on the other side of the relationship.
string ("customer" | "location" | "booking")
required
What the contact is linked to: customer, location or booking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_CUSTOMER_CONTACTRemove one contact entry from a customer in ServiceTitan.

Input Parameters

integer
required
Id of the contact entry, from the matching contacts list tool. This is a numeric id, not a contact GUID.
integer
required
Id of the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_CUSTOMER_NOTEDelete one note from a customer in ServiceTitan.

Input Parameters

integer
required
Id of the note to delete, from the matching notes list tool.
integer
required
Id of the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_EQUIPMENT_SYSTEMDelete a ServiceTitan equipment system by id.

Input Parameters

integer
required
Id of the equipment system to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_ESTIMATE_ITEMRemove one line item from an estimate in ServiceTitan. The removal is permanent.

Input Parameters

integer
required
Id of the estimate line item to remove.
integer
required
Id of the estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_FINDING_ATTACHMENTRemove an attachment from a ServiceTitan finding, by finding id and attachment id.

Input Parameters

integer
required
Id of the finding that owns the attachment.
integer
required
Id of the finding attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_GROSS_PAY_ITEMDelete a gross pay item in ServiceTitan by its id. The spec documents no response body and no way to restore a deleted item.

Input Parameters

integer
required
Id of the gross pay item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_INVOICE_ITEMDelete one line item from an invoice in ServiceTitan. The item is removed from the invoice and its totals; the documented response has no body.

Input Parameters

integer
required
Id of the invoice item.
integer
required
Id of the invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_JOB_ATTACHMENTDelete one attachment from a job in ServiceTitan. The spec documents no way to restore a deleted attachment.

Input Parameters

integer
required
Id of the job.
integer
required
Id of the job attachment to delete. The spec describes it as the id returned when the attachment was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_JOURNAL_ENTRYDelete a journal entry in ServiceTitan. Only external entries, those created through the API, can be deleted; the spec documents no way to restore one.

Input Parameters

string
required
Id of the journal entry (a GUID string), from LIST_JOURNAL_ENTRIES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_LOCATION_CONTACTRemove one contact entry from a location in ServiceTitan.

Input Parameters

integer
required
Id of the contact entry, from the matching contacts list tool. This is a numeric id, not a contact GUID.
integer
required
Id of the location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_LOCATION_NOTEDelete one note from a location in ServiceTitan.

Input Parameters

integer
required
Id of the note to delete, from the matching notes list tool.
integer
required
Id of the location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_NON_JOB_APPOINTMENTDelete a ServiceTitan non-job appointment by its ID.

Input Parameters

integer
required
ID of the non-job appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_PAYROLL_ADJUSTMENTDelete a payroll adjustment in ServiceTitan by its id. employee_type is required and must match the adjustment’s owner; the spec documents no way to restore it.

Input Parameters

string ("Technician" | "Employee")
required
Type of the person the adjustment belongs to: Technician or Employee. Required.
integer
required
Id of the payroll adjustment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_PRICEBOOK_CATEGORYDelete a category from the ServiceTitan pricebook by id. To hide a category without deleting it, use UPDATE_PRICEBOOK_CATEGORY with active set to false.

Input Parameters

integer
required
Id of the pricebook category to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_PRICEBOOK_DISCOUNT_OR_FEEDelete a discount or fee from the ServiceTitan pricebook by id. To hide it without deleting, use UPDATE_PRICEBOOK_DISCOUNT_OR_FEE with active set to false.

Input Parameters

integer
required
Id of the discount or fee to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_PRICEBOOK_EQUIPMENTDelete an equipment item from the ServiceTitan pricebook catalog by id. To hide it without deleting, use UPDATE_PRICEBOOK_EQUIPMENT with active set to false.

Input Parameters

integer
required
Id of the pricebook equipment item to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_PRICEBOOK_MATERIALDelete a material from the ServiceTitan pricebook by id. To hide it without deleting, use UPDATE_PRICEBOOK_MATERIAL with active set to false.

Input Parameters

integer
required
Id of the pricebook material to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_PRICEBOOK_SERVICEDelete a service from the ServiceTitan pricebook by id. To hide it without deleting, use UPDATE_PRICEBOOK_SERVICE with active set to false.

Input Parameters

integer
required
Id of the pricebook service to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_PROJECT_DAILY_LOG_ATTACHMENTDelete one attachment from a ServiceTitan project daily log. The file is removed from the log.

Input Parameters

integer
required
The project ID.
integer
required
ID of the daily log.
integer
required
The attachment ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_PURCHASE_ORDER_MARKUPDelete a ServiceTitan purchase order markup tier by id.

Input Parameters

integer
required
Id of the purchase order markup to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_TEAMDelete a ServiceTitan dispatch team by its ID.

Input Parameters

integer
required
ID of the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_TECHNICIAN_SHIFTDelete one ServiceTitan technician shift by its ID.

Input Parameters

integer
required
ID of the technician shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_TECHNICIAN_SKILLRemove a skill from a ServiceTitan technician by deleting the technician-skill association, whose ID has the form {technicianId}_{skillId}.

Input Parameters

string
required
ID of the technician skill, a string of the form {technicianId}_{skillId}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_TIMESHEET_ACTIVITYDelete a timesheet activity in ServiceTitan by its id. The recorded time is removed; the spec documents no way to restore it.

Input Parameters

integer
required
Id of the timesheet activity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DELETE_ZONEDelete a ServiceTitan dispatch zone by its ID.

Input Parameters

integer
required
ID of the zone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DETACH_JOB_EQUIPMENTDetach one or more equipment items from a ServiceTitan job in a single call. Returns a success acknowledgement.

Input Parameters

integer
required
ID of the job.
array
required
IDs of the equipment items to detach from the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DETACH_JOB_FROM_PROJECTDetach a ServiceTitan job from whichever project it belongs to. Only the job ID is given; the project is not named.

Input Parameters

integer
required
ID of the job to detach from its project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DISMISS_BOOKINGDismiss a booking in ServiceTitan for a given booking provider, marking it as not converted to a job. Optionally record a call reason and a memo; no way to undo this is documented.

Input Parameters

integer
required
Id of the booking.
integer
Id of the call reason recorded as the reason for dismissing the booking, from LIST_CALL_REASONS.
string
Free-text memo explaining why the booking was dismissed.
string
required
Id of the booking provider tag this connection was granted, from LIST_BOOKING_PROVIDER_TAGS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DISMISS_ESTIMATEMark an estimate as dismissed in ServiceTitan, for a quote the customer will not accept. The estimate is kept, with status Dismissed. No operation to reopen a dismissed estimate is documented; UPDATE_ESTIMATE takes a status field, but whether setting it to Open undoes a dismissal is not documented.

Input Parameters

integer
required
Id of the estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_DISMISS_LEADDismiss a lead in ServiceTitan so it needs no further follow-up. A call reason id is required as the dismissal reason; no way to reopen a lead is documented.

Input Parameters

integer
required
Id of the lead.
integer
required
Id of the call reason recorded as the reason for dismissing the lead, from LIST_CALL_REASONS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_APPOINTMENT_ASSIGNMENTSExport ServiceTitan technician-to-appointment assignments in bulk as a continuation feed. Use it for full or incremental sync; use List Appointment Assignments when you need filters.

Input Parameters

string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_APPOINTMENTSExport ServiceTitan job appointments in bulk as a continuation feed. Use it for full or incremental sync; use List Appointments when you need filters beyond active status.

Input Parameters

string ("True" | "Any" | "False")
Filter by active status: True (active only), False (inactive only), Any (both). When omitted, this operation returns both active and inactive items.
string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_BOOKINGSExport bookings from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch; use LIST_BOOKINGS for filtered lookups.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_BUSINESS_UNITSExport feed of business units from ServiceTitan for bulk sync. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_BUSINESS_UNITS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_CALLSExport feed of phone calls from ServiceTitan for bulk sync; each record carries an active flag. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_CALLS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_CUSTOMER_CONTACTSExport customer contact entries from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch. Use LIST_CUSTOMER_CONTACTS for a filtered lookup across customers, or LIST_CUSTOMER_CONTACTS for one customer.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_CUSTOMERSExport customers from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch; use LIST_CUSTOMERS for filtered lookups.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_EMPLOYEESExport feed of employees from ServiceTitan for bulk sync. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_EMPLOYEES instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_EQUIPMENT_SYSTEMSExport equipment systems from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; set include_recent_changes to receive the most recent changes sooner. Use LIST_EQUIPMENT_SYSTEMS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_ESTIMATESExport estimates from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from on the next call; has_more false means the feed is caught up. Use LIST_ESTIMATES for filtered lookups.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_GROSS_PAY_ITEMSExport gross pay items from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_GROSS_PAY_ITEMS instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_INSTALLED_EQUIPMENTExport installed equipment records from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; set include_recent_changes to receive the most recent changes sooner. Use LIST_INSTALLED_EQUIPMENT instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_INVENTORY_ADJUSTMENTSExport inventory adjustments from ServiceTitan as a continuation feed for bulk sync, with no filters. Pass the returned continue_from token back to get the next batch; use LIST_INVENTORY_ADJUSTMENTS for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_INVENTORY_BILLSExport inventory bills from ServiceTitan as a continuation feed for bulk sync: returns active, inactive and deleted records with no filters. Pass the returned continue_from on the next call; use LIST_INVENTORY_BILLS instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_INVENTORY_RETURNSExport vendor returns from ServiceTitan inventory as a continuation feed for bulk sync, with no filters. Pass the returned continue_from token back to get the next batch. Use LIST_INVENTORY_RETURNS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_INVENTORY_TRANSFERSExport inventory transfers from ServiceTitan as a continuation feed for bulk sync, with no filters. Pass the returned continue_from token back to get the next batch. Use LIST_INVENTORY_TRANSFERS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_INVOICE_ITEMSExport invoice line items from ServiceTitan as a continuation feed for bulk sync: returns active, inactive and deleted records with no filters. Pass the returned continue_from on the next call and keep it to pick up later changes.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_INVOICESExport invoices from ServiceTitan as a continuation feed for bulk sync: returns active, inactive and deleted records with no filters. Pass the returned continue_from on the next call; use LIST_INVOICES instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_INVOICE_TEMPLATESExport feed of membership invoice templates from ServiceTitan for bulk sync; the only way to enumerate templates without knowing their ids. The feed takes no filters and each record carries an active flag; pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_INVOICE_TEMPLATES or GET_INVOICE_TEMPLATE when the template ids are already known.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_JOB_CANCELED_LOGSExport ServiceTitan job canceled logs (who canceled which job, when, and why) in bulk as a continuation feed. For the canceled logs of one job use LIST_JOB_CANCELED_LOGS.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_JOB_HISTORYExport the status history of all ServiceTitan jobs in bulk as a continuation feed. For one job use Get Job History.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_JOB_NOTESExport notes from all ServiceTitan jobs in bulk as a continuation feed. For the notes of one job use List Job Notes.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_JOBSExport ServiceTitan jobs in bulk as a continuation feed that includes active, inactive and deleted records. Use it for full or incremental sync; use List Jobs when you need filters.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_LEADSExport leads from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch; use LIST_LEADS for filtered lookups.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_LOCATION_CONTACTSExport location contact entries from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch. Use LIST_LOCATION_CONTACTS for a filtered lookup across locations, or LIST_LOCATION_CONTACTS for one location.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_LOCATIONSExport locations from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch; use LIST_LOCATIONS for filtered lookups.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_MEMBERSHIPSExport feed of customer memberships from ServiceTitan for bulk sync; the feed takes no filters and each record carries an active flag and a status. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_MEMBERSHIPS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_MEMBERSHIP_STATUS_CHANGESExport feed of customer membership status changes from ServiceTitan, across all memberships; each record gives the old and new status. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. For the history of one membership use LIST_MEMBERSHIP_STATUS_CHANGES.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_MEMBERSHIP_TYPESExport feed of membership types from ServiceTitan for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_MEMBERSHIP_TYPES instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PAYMENTSExport customer payments from ServiceTitan as a continuation feed for bulk sync: returns active, inactive and deleted records with no filters. Pass the returned continue_from on the next call; use LIST_PAYMENTS instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PAYROLL_ACTIVITY_CODESExport payroll activity codes (earning codes) from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_ACTIVITY_CODES instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PAYROLL_ADJUSTMENTSExport payroll adjustments from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_ADJUSTMENTS instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PAYROLL_JOB_SPLITSExport payroll job splits (each technician’s split of a job) from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_JOB_SPLITS instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PAYROLL_JOB_TIMESHEETSExport job timesheets (technician dispatch, arrival and completion times on job appointments) from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_JOB_TIMESHEETS instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PAYROLL_SETTINGSExport employee and technician payroll settings from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_PAYROLL_SETTINGS instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PRICEBOOK_CATEGORIESExport pricebook categories from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; records appear about 15 minutes after a change unless include_recent_changes is true. Use LIST_PRICEBOOK_CATEGORIES instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PRICEBOOK_EQUIPMENTExport pricebook equipment items from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; records appear about 15 minutes after a change unless include_recent_changes is true. Use LIST_PRICEBOOK_EQUIPMENT instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PRICEBOOK_MATERIALSExport pricebook materials from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; records appear about 15 minutes after a change unless include_recent_changes is true. Use LIST_PRICEBOOK_MATERIALS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PRICEBOOK_SERVICESExport pricebook services from ServiceTitan as a continuation feed for bulk sync. Pass the returned continue_from token back to get the next batch; records appear about 15 minutes after a change unless include_recent_changes is true. Use LIST_PRICEBOOK_SERVICES instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PROJECT_NOTESExport notes from all ServiceTitan projects in bulk as a continuation feed. For the notes of one project use List Project Notes.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PROJECTSExport ServiceTitan projects in bulk as a continuation feed that includes active, inactive and deleted records. Use it for full or incremental sync; use List Projects when you need filters.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_PURCHASE_ORDERSExport purchase orders from ServiceTitan as a continuation feed for bulk sync; use LIST_PURCHASE_ORDERS when you need filters. Pass the returned continue_from token back to get the next batch.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_RECEIPTSExport inventory receipts from ServiceTitan as a continuation feed for bulk sync. Pass continue_from from each response to get the next batch. Use LIST_INVENTORY_RECEIPTS for filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_RECURRING_SERVICE_EVENTSExport feed of recurring service events from ServiceTitan for bulk sync; the feed takes no filters, and an event with active false has been deleted. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_RECURRING_SERVICE_EVENTS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_RECURRING_SERVICESExport feed of location recurring services from ServiceTitan for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_RECURRING_SERVICES instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_RECURRING_SERVICE_TYPESExport feed of recurring service types from ServiceTitan for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_RECURRING_SERVICE_TYPES instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_SERVICE_AGREEMENTSExport feed of service agreements from ServiceTitan for bulk sync. Returns active, inactive and deleted records; pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_SERVICE_AGREEMENTS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_TAG_TYPESExport feed of tag types from ServiceTitan for bulk sync. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_TAG_TYPES instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_TECHNICIAN_RATINGSExport technician ratings from ServiceTitan as a change feed for bulk sync, one batch per call. Pass the returned continue_from back to get the next batch. Use LIST_TECHNICIAN_RATINGS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_TECHNICIANSExport feed of technicians from ServiceTitan for bulk sync. Pass the returned continue_from on the next call, and has_more false means the feed is caught up. Use LIST_TECHNICIANS instead for a filtered, paged lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_TIMESHEET_ACTIVITIESExport timesheet activities from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_TIMESHEET_ACTIVITIES instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_TIMESHEET_ACTIVITY_CATEGORIESExport timesheet activity categories from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_TIMESHEET_ACTIVITY_CATEGORIES instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_TIMESHEET_ACTIVITY_TYPESExport timesheet activity types from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_TIMESHEET_ACTIVITY_TYPES instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_EXPORT_TIMESHEET_CODESExport timesheet codes from ServiceTitan as a continuation feed for bulk sync; the feed takes no filters and each record carries an active flag. Pass the returned continue_from on the next call; use LIST_TIMESHEET_CODES instead for a filtered lookup.

Input Parameters

string
Continuation token from the continue_from field of the previous response. Omit to start from the beginning, or pass a date such as 2020-01-01 to start from that point in time.
boolean
Set true to receive the most recent changes sooner. The same record can then appear again on consecutive calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_AP_BILLGet one accounts-payable (vendor) bill in ServiceTitan by its id, including items and expense items. Use LIST_AP_BILLS to find the id.

Input Parameters

integer
required
Id of the AP bill.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_APPOINTMENTGet one ServiceTitan job appointment by its ID, including its schedule, arrival window, status and confirmation flag. Use List Appointments to find the ID from a job or project.

Input Parameters

integer
required
ID of the job appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_ARRIVAL_WINDOWGet one ServiceTitan arrival window by its ID.

Input Parameters

integer
required
ID of the arrival window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_ARRIVAL_WINDOW_CONFIGURATIONGet the tenant-wide ServiceTitan arrival window setting: whether a job’s default start time is the start or the end of the chosen arrival window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_BOOKINGGet one booking in ServiceTitan by id, across all booking providers. Use GET_PROVIDER_BOOKING when the connection is restricted to a single booking provider tag.

Input Parameters

integer
required
Id of the booking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_BOOKING_PROVIDER_TAGGet one booking provider tag in ServiceTitan by its id.

Input Parameters

integer
required
Id of the booking provider tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_BUSINESS_HOURSGet the ServiceTitan business hours: the open time ranges for weekdays, Saturday and Sunday. Returns one object, not a list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_BUSINESS_UNITGet one business unit in ServiceTitan by id, including its name, address, email and phone.

Input Parameters

integer
required
Id of the business unit.
string
Application GUID. When given, the external data stored under this GUID is returned with the business unit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CALLGet one phone call in ServiceTitan by id, with the linked job, customer, campaign and agent.

Input Parameters

integer
required
Id of the call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CALL_RECORDINGDownload the audio recording of one call from ServiceTitan as an audio/mpeg file. Use it for a call whose recording_url is set; the response for a call with no recording is not documented.

Input Parameters

integer
required
Id of the call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CALL_VOICEMAILDownload the voicemail audio left on one call from ServiceTitan as an audio/mpeg file. Use it for a call whose voicemail URL is set; the response for a call with no voicemail is not documented.

Input Parameters

integer
required
Id of the call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CAMPAIGNGet one marketing campaign in ServiceTitan by id.

Input Parameters

integer
required
Id of the marketing campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CAMPAIGN_CATEGORYGet one marketing campaign category in ServiceTitan by id.

Input Parameters

integer
required
Id of the campaign category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CAMPAIGN_COSTGet one campaign cost record in ServiceTitan by the cost record’s id, not the campaign id.

Input Parameters

integer
required
Id of the campaign cost record, from LIST_CAMPAIGN_COSTS. This is not the campaign id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CAMPAIGN_COST_SUMMARYGet the total cost of each marketing campaign in ServiceTitan over a date range. Both from_date and to_date are required; the result is not paged.

Input Parameters

string
required
End of the date range. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Start of the date range. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CANCEL_REASONS_BY_JOB_IDSGet recorded cancellation reasons for up to 50 specified ServiceTitan job IDs. The response may indicate more records exist, but this tool does not accept a page parameter.

Input Parameters

array
required
IDs of the jobs to get cancel reasons for. List of ids, max 50, sent comma-separated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CAPACITYCalculate real-time ServiceTitan capacity and technician availability for a time frame, optionally for given business units and a job type. Read-only even though it is a POST; use it before booking a job to find open slots.

Input Parameters

integer
ID of the job type whose duration is used to calculate availability.
array
IDs of the business units to calculate availability for.
string
required
End of the time frame to calculate capacity for. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Start of the time frame to calculate capacity for. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
required
Whether to match availability on the skills the job type needs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CONTACTGet one contact (a person record with name and title) in ServiceTitan by its GUID. Phone numbers and emails are not included; read them with LIST_CONTACT_METHODS.

Input Parameters

string
required
GUID of the contact, from LIST_CONTACTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CONTACT_METHODGet one contact method of a contact in ServiceTitan. Both ids are GUIDs.

Input Parameters

string
required
GUID of the contact, from LIST_CONTACTS.
string
required
GUID of the contact method, from LIST_CONTACT_METHODS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CONTACT_METHOD_PREFERENCEGet one communication preference of a contact method in ServiceTitan by preference name. Names come from LIST_CONTACT_PREFERENCE_TYPES.

Input Parameters

string
required
GUID of the contact, from LIST_CONTACTS.
string
required
Name of the preference, from LIST_CONTACT_PREFERENCE_TYPES.
string
required
GUID of the contact method, from LIST_CONTACT_METHODS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_CUSTOMERGet one customer in ServiceTitan by id, including bill-to address, balance, custom fields and tags.

Input Parameters

integer
required
Id of the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_EMAIL_CHANNEL_COSTGet the cost of the email marketing channel in ServiceTitan over a date range. Both from_date and to_date are required.

Input Parameters

string
required
End of the date range. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Start of the date range. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_EMPLOYEEGet one office employee in ServiceTitan by ID, including name, email, phone and role.

Input Parameters

integer
required
Id of the employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_EMPLOYEE_PAYROLL_SETTINGSGet the payroll settings of one office employee in ServiceTitan. Use GET_TECHNICIAN_PAYROLL_SETTINGS for a technician.

Input Parameters

integer
required
Id of the office employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_EQUIPMENT_SYSTEMGet one ServiceTitan equipment system by id, including the installed equipment attached to it.

Input Parameters

integer
required
Id of the equipment system to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_EQUIPMENT_TYPEGet one ServiceTitan equipment type by id.

Input Parameters

integer
required
Id of the equipment type to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_ESTIMATEGet one estimate in ServiceTitan by its id, including its status, totals and line items.

Input Parameters

integer
required
Id of the estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_ESTIMATE_TEMPLATEGet one estimate template in ServiceTitan by its id, with its items.

Input Parameters

integer
required
Id of the estimate template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_EXPENSE_TRANSACTIONGet one expense transaction in ServiceTitan by its id. Use LIST_EXPENSE_TRANSACTIONS to find the id.

Input Parameters

integer
required
Id of the expense transaction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_FINDINGGet one ServiceTitan finding by id.

Input Parameters

integer
required
Id of the finding to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_FINDING_ATTACHMENTGet one attachment of a ServiceTitan finding, by finding id and attachment id.

Input Parameters

integer
required
Id of the finding that owns the attachment.
integer
required
Id of the finding attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_GL_ACCOUNTGet one general ledger (GL) account in ServiceTitan by its id. Use LIST_GL_ACCOUNTS to find the id.

Input Parameters

integer
required
Id of the general ledger account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_HOLD_REASONS_BY_JOB_IDSGet recorded hold reasons for the given ServiceTitan jobs and their appointments. The response may indicate more records exist, but this tool cannot request another page.

Input Parameters

array
required
IDs of the jobs to get hold reasons for. List of ids, max 50, sent comma-separated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_INSTALLED_EQUIPMENTGet one ServiceTitan installed equipment record by id.

Input Parameters

integer
required
Id of the installed equipment record to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_INVOICE_TEMPLATEGet one membership invoice template in ServiceTitan by its id, with its line items and total.

Input Parameters

integer
required
Id of the membership invoice template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_JOBGet one ServiceTitan job by its ID, including customer, location, job type, status and first and last appointment IDs.

Input Parameters

integer
required
ID of the job.
string
If this GUID is provided, external data corresponding to this application GUID will be returned. GUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_JOB_BOOKED_LOGGet the booked log of one ServiceTitan job: when it was booked, by whom, and the originally booked appointment start and arrival window.

Input Parameters

integer
required
ID of the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_JOB_EQUIPMENTGet the IDs of the equipment items attached to one ServiceTitan job. Returns IDs only. The spec does not say which equipment ids these are; they are not the equipment system ids of the equipment-system tools, and whether installed-equipment ids (LIST_INSTALLED_EQUIPMENT) or pricebook equipment ids (LIST_PRICEBOOK_EQUIPMENT) are meant is unverified.

Input Parameters

integer
required
ID of the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_JOB_HISTORYGet the history entries of one ServiceTitan job: each event with its type, date, employee and memo. Returns the whole history in one response.

Input Parameters

integer
required
ID of the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_JOB_TYPEGet one ServiceTitan job type by its ID.

Input Parameters

integer
required
ID of the job type.
string
If this guid is provided, external data corresponding to this application guid will be returned. GUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_JOURNAL_ENTRYGet one journal entry in ServiceTitan by its id. It returns the entry header; use LIST_JOURNAL_ENTRY_DETAILS or LIST_JOURNAL_ENTRY_SUMMARY for its line amounts.

Input Parameters

string
required
Id of the journal entry (a GUID string), from LIST_JOURNAL_ENTRIES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_LABOR_TYPEGet one payroll labor type in ServiceTitan by its id. Use LIST_LABOR_TYPES to find the id.

Input Parameters

integer
required
Id of the payroll labor type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_LEADGet one lead in ServiceTitan by id. A lead is an opportunity to book a job that has not converted yet.

Input Parameters

integer
required
Id of the lead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_LOCATIONGet one location in ServiceTitan by id. A location is the service address where work is done and belongs to exactly one customer.

Input Parameters

integer
required
Id of the location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_LOCATION_PREFERRED_TECHNICIANGet the id of the preferred technician of a location in ServiceTitan. Returns only the technician id, or null when none is set.

Input Parameters

integer
required
Id of the location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_MEMBERSHIPGet one customer membership in ServiceTitan by its id, including status, dates, billing template and payment settings.

Input Parameters

integer
required
Id of the customer membership.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_MEMBERSHIP_TYPEGet one membership type in ServiceTitan by its id. The spec gives this operation no include flags and does not say whether duration_billing, discounts, recurring_services and tag_type_ids are filled; null means not loaded. LIST_MEMBERSHIP_TYPES with ids and the include_ flags returns them.

Input Parameters

integer
required
Id of the membership type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_NON_JOB_APPOINTMENTGet one ServiceTitan non-job appointment by its ID. A non-job appointment blocks a technician’s time for something that is not customer work, such as training or time off.

Input Parameters

integer
required
ID of the non-job appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PAYMENT_TERMGet one payment term (for example net 30) in ServiceTitan by its id. Payment terms are read-only through the API.

Input Parameters

integer
required
Id of the payment term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PAYMENT_TYPEGet one payment type in ServiceTitan by its id. Use LIST_PAYMENT_TYPES to find the id.

Input Parameters

integer
required
Id of the payment type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PAYROLL_ACTIVITY_CODEGet one payroll activity code (earning code) in ServiceTitan by its id. Use LIST_PAYROLL_ACTIVITY_CODES to find the id.

Input Parameters

integer
required
Id of the payroll activity code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PAYROLL_ADJUSTMENTGet one payroll adjustment in ServiceTitan by its id. employee_type is required and must match the adjustment’s owner (Technician or Employee).

Input Parameters

string ("Technician" | "Employee")
required
Type of the person the adjustment belongs to: Technician or Employee. Required.
integer
required
Id of the payroll adjustment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PRICEBOOK_CATEGORYGet one ServiceTitan pricebook category by id, including its subcategories.

Input Parameters

integer
required
Id of the pricebook category to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PRICEBOOK_DISCOUNT_OR_FEEGet one discount or fee from the ServiceTitan pricebook by id.

Input Parameters

integer
required
Id of the discount or fee to get.
string
Application GUID whose external data should be returned with the record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PRICEBOOK_EQUIPMENTGet one equipment item from the ServiceTitan pricebook catalog by id.

Input Parameters

integer
required
Id of the pricebook equipment item to get.
string
Application GUID whose external data should be returned with the record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PRICEBOOK_MATERIALGet one material from the ServiceTitan pricebook by id.

Input Parameters

integer
required
Id of the pricebook material to get.
string
Application GUID whose external data should be returned with the record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PRICEBOOK_MATERIAL_MARKUPGet one material markup tier from the ServiceTitan pricebook by id.

Input Parameters

integer
required
Id of the material markup to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PRICEBOOK_SERVICEGet one service from the ServiceTitan pricebook by id, including its linked materials and equipment.

Input Parameters

integer
required
Id of the pricebook service to get.
boolean
Set true to return prices calculated with the current dynamic pricing rules. The spec documents false as the default.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PROJECTGet one ServiceTitan project by its ID, including status, customer, location, managers and key dates.

Input Parameters

integer
required
ID of the project.
string
If this guid is provided, external data corresponding to this application guid will be returned. GUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PROJECT_DAILY_LOGGet one daily log of a ServiceTitan project by its ID, with health, section notes, summaries and the attachment list.

Input Parameters

integer
required
The project ID.
integer
required
ID of the daily log.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PROJECT_STATUSGet one ServiceTitan project status definition by its ID. This is the status catalogue entry, not the status of a project.

Input Parameters

integer
required
ID of the project status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PROJECT_SUB_STATUSGet one ServiceTitan project sub status definition by its ID.

Input Parameters

integer
required
ID of the project sub status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PROJECT_TYPEGet one ServiceTitan project type by its ID.

Input Parameters

integer
required
ID of the project type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PROPOSAL_TEMPLATEGet one proposal template in ServiceTitan by its id, with its estimate assignments.

Input Parameters

integer
required
Id of the proposal template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PROVIDER_BOOKINGGet one booking in ServiceTitan that belongs to a given booking provider. Works only when the connection was granted the booking provider tag passed as booking_provider_id.

Input Parameters

integer
required
Id of the booking.
integer
required
Id of the booking provider tag this connection was granted, from LIST_BOOKING_PROVIDER_TAGS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PURCHASE_ORDERGet one ServiceTitan purchase order by id, including its items and current status.

Input Parameters

integer
required
Id of the purchase order to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_PURCHASE_ORDER_MARKUPGet one ServiceTitan purchase order markup tier by id.

Input Parameters

integer
required
Id of the purchase order markup to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_RECURRING_SERVICEGet one location recurring service in ServiceTitan by its id, including its recurrence schedule and invoice template ids.

Input Parameters

integer
required
Id of the location recurring service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_RECURRING_SERVICE_TYPEGet one recurring service type in ServiceTitan by its id.

Input Parameters

integer
required
Id of the recurring service type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_REMITTANCE_VENDORGet one remittance vendor in ServiceTitan by its id. Use LIST_REMITTANCE_VENDORS to find the id.

Input Parameters

integer
required
Id of the remittance vendor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_REPORTGet a report’s definition in ServiceTitan: the input parameters it expects and the fields it returns. Read it before requesting data, because report owners can change the definition.

Input Parameters

integer
required
Id of the report within the category, from the reports list.
string
required
Id of the report category, from the report categories list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_REPORT_DATARun a report in ServiceTitan and return one page of rows with the column headers. Rate limit: 1 call of the same report per minute per tenant, so ask for a large page_size (up to 25000) rather than many small pages; for slow reports use START_REPORT_DATA_QUERY and poll GET_REPORT_DATA_QUERY_RESULT.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of rows per page, 1 to 25000. Default 1000.
integer
required
Id of the report within the category, from the reports list.
array
required
Input parameters of the report as name/value pairs. Get the names, data types and required flags from the report definition.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
required
Id of the report category, from the report categories list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_REPORT_DATA_QUERY_RESULTPoll a long-running report data query in ServiceTitan by its query_token. Returns the rows when the query has finished, or a status of NotStarted or InProgress when it has not, in which case wait and call again.

Input Parameters

string
required
Token of the long-running query, returned when the query was started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_ROUTER_PERFORMANCEGet performance counts for one Scheduling Pro router in ServiceTitan over a time window: total sessions opened and interacted with, and opened sessions split by scheduler. Both window bounds are required.

Input Parameters

string
required
Id of the Scheduling Pro router (a string). No ServiceTitan API lists routers, so the id has to come from the user.
string
required
End of the window: count sessions created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Start of the window: count sessions created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_SCHEDULER_PERFORMANCEGet performance metrics for one Scheduling Pro scheduler in ServiceTitan over a time window, such as sessions, completion rates and jobs booked. Both window bounds are required.

Input Parameters

string
required
Id of the Scheduling Pro scheduler (a string), from the schedulers list.
string
required
End of the window: count sessions created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Start of the window: count sessions created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_SERVICE_AGREEMENTGet one service agreement in ServiceTitan by id, with its price, dates, status and terms.

Input Parameters

integer
required
Id of the service agreement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TASKGet one task in ServiceTitan Task Management by id, with its comments and attachments. Set include_subtasks to true to also return its subtasks.

Input Parameters

integer
required
Id of the task.
boolean
Set true to include the task’s subtasks in sub_tasks_data. The spec does not document the default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TASK_REFERENCE_DATAGet the reference data needed to create tasks in ServiceTitan: employees, business units, task types, sources, resolutions, priorities and statuses. Call it first to get the ids the create task tool requires.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TEAMGet one ServiceTitan dispatch team by its ID.

Input Parameters

integer
required
ID of the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TECHNICIANGet one technician in ServiceTitan by id, including name, contact details, home address, zones and license type.

Input Parameters

integer
required
Id of the technician.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TECHNICIAN_PAYROLL_SETTINGSGet the payroll settings of one technician in ServiceTitan. Use GET_EMPLOYEE_PAYROLL_SETTINGS for an office employee.

Input Parameters

integer
required
Id of the technician.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TECHNICIAN_SHIFTGet one ServiceTitan technician shift by its ID.

Input Parameters

integer
required
ID of the technician shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TECHNICIAN_SKILLGet one ServiceTitan technician skill by its ID, which is a string of the form {technicianId}_{skillId}.

Input Parameters

string
required
ID of the technician skill, a string of the form {technicianId}_{skillId}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TECHNICIAN_TRACKING_URLGet the ServiceTitan tracking URL for one technician on one appointment, which shows the technician’s progress toward the customer. Both the technician and appointment IDs are required.

Input Parameters

integer
required
ID of the technician to track.
integer
required
ID of the appointment the tracking URL is for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TIMESHEET_ACTIVITYGet one timesheet activity in ServiceTitan by its id. Use LIST_TIMESHEET_ACTIVITIES to find the id.

Input Parameters

integer
required
Id of the timesheet activity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TIMESHEET_ACTIVITY_CATEGORYGet one timesheet activity category in ServiceTitan by its id. Use LIST_TIMESHEET_ACTIVITY_CATEGORIES to find the id.

Input Parameters

integer
required
Id of the timesheet activity category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TIMESHEET_ACTIVITY_TYPEGet one timesheet activity type in ServiceTitan by its id. Use LIST_TIMESHEET_ACTIVITY_TYPES to find the id.

Input Parameters

integer
required
Id of the timesheet activity type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_TIMESHEET_CODEGet one timesheet code in ServiceTitan by its id. Use LIST_TIMESHEET_CODES to find the id.

Input Parameters

integer
required
Id of the timesheet code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_VENDORGet one ServiceTitan inventory vendor by id, including contact details, tax rate, and delivery option.

Input Parameters

integer
required
Id of the vendor to get.
string
External data key to look up. external_data_values must also be given.
string
External data values to look up, maximum 50. external_data_key must also be given. The spec types this as one plain string and the format for several values is undocumented.
string
Application GUID whose external data should be returned with the record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_WELL_KNOWN_GL_ACCOUNTSGet the ids of the tenant’s default general ledger accounts in ServiceTitan: credit card payable and uncategorized expense. Each id is null when that default account is not configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_GET_ZONEGet one ServiceTitan dispatch zone by its ID, including its zip codes, cities, service days, business units and technicians.

Input Parameters

integer
required
ID of the zone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_HOLD_APPOINTMENTPut a ServiceTitan job appointment on hold with a hold reason and memo. Get the reason ID from List Job Hold Reasons.

Input Parameters

string
required
Memo of why the appointment is going on hold.
integer
required
ID of the hold reason.
integer
required
ID of the job appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_IMPORT_SMS_OPT_INSImport SMS marketing opt-ins into ServiceTitan for phone numbers whose consent was collected externally. Send only numbers whose owners agreed to receive text messages; check the returned successful, invalid and unsuccessful numbers for individual outcomes.

Input Parameters

array
required
Phone numbers that opted in to SMS. At least one. The spec does not document the expected number format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_AD_PERFORMANCEList ad performance rows from ServiceTitan Marketing Ads for a time window, segmented by campaign, ad group or keyword, one page per call. from_utc, to_utc and segmentation_type are required.

Input Parameters

integer
Page number to return, starting at 1.
string
required
End of the time window. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Start of the time window. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string ("Campaign" | "AdGroup" | "Keyword")
required
Level the performance rows are grouped by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_AP_BILL_CUSTOM_FIELD_TYPESList the custom field type definitions available for AP bills in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_AP_BILL_CUSTOM_FIELDS.

Input Parameters

string
Return records whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_AP_BILLSList accounts-payable (vendor) bills in ServiceTitan with their line items, one page per call. Filter by bill number, status, sync status, source, cost or dates; bill_type defaults to Procurement, so pass ApBill to see standalone AP bills.

Input Parameters

array
Return only the AP bills with these ids; sent comma-separated. The spec documents no maximum for this operation.
integer
Page number to return, starting at 1.
string
Filter bills created on or before this date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Return only bills created from one of these sources: Undefined, Standalone, Purchasing, Recurring, OCR, API.
integer
Filter by specific batch ID.
number
Filter bills with cost less than or equal to this amount.
number
Filter bills with cost greater than or equal to this amount.
array
Return only bills with one of these reconciliation statuses: Unreconciled, Discrepancy, Reconciled, Canceled.
string ("NotSet" | "Procurement" | "ApBill")
Filter by bill type; Procurement is used when left out.
string
Filter bills created on or after this date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Number of records per page.
string
Filter by job number (partial match supported).
string
Filter by bill number (partial match supported).
integer
Filter by batch number.
object
Custom field name-value filters, up to 50. Each entry is sent as customField.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
array
Filter by sync status values: Pending, Posted, Exported, PostedAndExported.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
List of business unit IDs to filter by, sent comma-separated.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
List of purchase order types to filter by, sent comma-separated. The spec does not list the valid values.
string ("And" | "Or")
Operator between custom field filters: And or Or. Default And.
string
Filter by purchase order number (partial match supported).
string
Return bills reconciled on or before this date-time, as the spec words it; the parameter name says before, so whether the boundary is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return bills reconciled after this date-time, as the spec words it; the parameter name says on or after, so whether the boundary is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("NoDiscrepancy" | "Discrepancy")
Filter by three-way match discrepancy status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_AP_CREDIT_CUSTOM_FIELD_TYPESList the custom field type definitions available for AP credits in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_AP_CREDIT_CUSTOM_FIELDS.

Input Parameters

string
Return records whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_AP_CREDITSList accounts-payable credits (vendor credits) in ServiceTitan, one page per call. Filter by ids, sync status, or created or modified dates.

Input Parameters

array
List of AP credit ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
object
Custom field name-value filters, up to 50. Each entry is sent as customField.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
array
Return only AP credits with one of these accounting sync statuses: Pending, Posted, Exported, PostedAndExported.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("And" | "Or")
Operator between custom field filters: And or Or. Default And.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_AP_PAYMENT_CUSTOM_FIELD_TYPESList the custom field type definitions available for AP payments in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_AP_PAYMENT_CUSTOM_FIELDS.

Input Parameters

string
Return records whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_AP_PAYMENTSList accounts-payable payments (payments made to vendors) in ServiceTitan, one page per call. These are outgoing vendor payments; use LIST_PAYMENTS for payments received from customers.

Input Parameters

array
List of AP payment ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
object
Custom field name-value filters, up to 50. Each entry is sent as customField.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
array
Return only AP payments with one of these accounting sync statuses: Pending, Posted, Exported or PostedAndExported. Sent as a repeated query parameter.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("And" | "Or")
Operator between custom field filters: And or Or. Default And.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_APPOINTMENT_ASSIGNMENTSList technician-to-appointment assignments in ServiceTitan, one page per call, filtered by appointment, job, technician or appointment start range. Use it to see who is assigned to an appointment.

Input Parameters

array
Return only the records with these IDs. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Return appointment assignments for a single job.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Return assignments for these technicians. List of ids, sent comma-separated; request URLs longer than 2048 characters are rejected.
array
Return assignments for these appointments. List of ids, sent comma-separated.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return appointment assignments whose appointment starts before the specified date-time, interpreted as UTC. Exclusive boundary. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return appointment assignments whose appointment starts on or after the specified date-time, interpreted as UTC. Inclusive boundary. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_APPOINTMENTSList ServiceTitan job appointments, one page per call, filtered by job, project, technician, customer, status or start/modified date ranges. Use this to find all appointments of a job or project.

Input Parameters

array
Return only the records with these IDs. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Return all appointments for this job.
string ("Scheduled" | "Dispatched" | "Working" | "Hold" | "Done" | "Canceled")
Return items with specified status AppointmentStatus.
boolean
Return appointments that are unused.
integer
Number of records per page.
integer
Return all appointments for jobs that are part of this project.
integer
Return appointments for the specified Customer.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return appointments that start before the specified date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Return appointments this technician is assigned to.
string
Return appointments created before a certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return appointments modified before a certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return appointments with this appointment number.
string
Return appointments that start on or after the specified date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return appointments created on or after a certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return appointments modified on or after a certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_ARRIVAL_WINDOWSList the arrival windows configured in ServiceTitan, one page per call. An arrival window is a time range, per business unit, offered to customers when booking.

Input Parameters

integer
Page number to return, starting at 1.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_ATTRIBUTED_LEADSList leads with their marketing attribution in ServiceTitan for a time window, one page per call. from_utc and to_utc are required.

Input Parameters

integer
Page number to return, starting at 1.
string
required
End of the time window. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
required
Start of the time window. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("Call" | "WebBooking" | "WebLeadForm" | "ManualJob")
Return only leads of this type. Omit to return all types.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BANK_DEPOSITSList bank deposits in ServiceTitan, one page per call. Filter by deposit date, review status, deposit status, sync status or gross amount.

Input Parameters

array
List of bank deposit ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
string ("Pending" | "Posted" | "Exported")
Return only bank deposits with this accounting sync status.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string ("NeedsReview" | "Reviewed")
Return only deposits with this review status.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("Undefined" | "Open" | "Deposited")
Return only deposits with this deposit status.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return deposits reviewed before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
number
Return deposits with a gross amount less than this value. The spec does not say whether the bound is inclusive.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return deposits with a deposit date before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
number
Return deposits with a gross amount greater than this value. The spec does not say whether the bound is inclusive.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return deposits reviewed on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return deposits with a deposit date on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BANK_DEPOSIT_TRANSACTIONSList the transactions (payments and journal entries) that make up one bank deposit in ServiceTitan, one page per call. Use LIST_BANK_DEPOSITS to find the deposit id.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
Id of the bank deposit.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BOOKING_CONTACTSList the contact entries (phone, email, fax) on one booking in ServiceTitan, one page per call. This is the tenant-wide path; it needs a connection with no booking provider restriction. Use LIST_PROVIDER_BOOKING_CONTACTS when the connection is restricted to a single booking provider tag.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
Id of the booking.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BOOKING_PROVIDER_TAGSList booking provider tags in ServiceTitan, one page per call. Use it to find the tag id that the provider-scoped booking tools take as booking_provider_id.

Input Parameters

array
Return only the records with these ids. Maximum 50; sent comma-separated.
string
Name of the booking provider tag.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BOOKINGSList bookings in ServiceTitan across all booking providers, one page per call. Use LIST_PROVIDER_BOOKINGS when the connection is restricted to a single booking provider tag.

Input Parameters

array
Return only the records with these ids. Maximum 50; sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
integer
Number of records per page.
string
Filters by booking’s external ID.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BUDGET_CODESList company-level ServiceTitan budget codes, one page per call, optionally filtered by budget code, segment or segment item IDs.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
array
Return only budget codes that use these segments. List of ids, sent comma-separated.
boolean
Set true to have total_count filled in the response; otherwise it is null.
array
Return only budget codes with these IDs. List of ids, sent comma-separated.
array
Return only budget codes that use these segment items. List of ids, sent comma-separated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BUDGET_CODE_SEGMENT_ITEM_CHILDRENList the child items under one item of a company-level budget code segment in ServiceTitan, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
ID of the budget code segment.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
required
ID of the segment item.
boolean
Whether to include the child items nested under each segment item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BUDGET_CODE_SEGMENT_ITEMSList items of one company-level budget code segment in ServiceTitan, one page per call. The include_children option requests child items nested under segment items.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
ID of the budget code segment.
boolean
Set true to have total_count filled in the response; otherwise it is null.
boolean
Whether to include the child items nested under each segment item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BUDGET_CODE_SEGMENTSList company-level budget code segments of the ServiceTitan work breakdown structure. Results can be requested by page; the response contains segment data without a continuation flag.

Input Parameters

integer
Page number to return, starting from 1. Not sent unless set; the spec documents no default for this operation.
integer
Number of records per page. Not sent unless set; the spec documents no default and no maximum for this operation. The response has no has_more flag: the last page is the one with fewer records than page_size.
boolean
Documented query parameter of this operation. The documented response has no total count field, so its effect is not known.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_BUSINESS_UNITSList business units in ServiceTitan, the divisions of the company that revenue and work are tracked and reported under. Returns one page per call.

Input Parameters

array
Return only the business units with these ids. Maximum 50; sent comma-separated.
string
Filter by name; case-insensitive ‘contains’ match.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Application GUID. When given, the external data stored under this GUID is returned with each business unit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CALL_REASONSList call reasons in ServiceTitan, one page per call. Use it to find the reason id needed to dismiss a lead or booking or to create a lead.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CALLSList one page of inbound and outbound phone calls recorded in ServiceTitan, with filters including campaign, agent, phone number, minimum duration, tag and created or modified time.

Input Parameters

array
List of ids to look up, max 50, sent comma-separated.
string
Filter by the call’s SID, the telephony provider’s identifier for the call.
string
Filter by call tag.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Filter by the id of the agent (employee) on the call.
integer
Number of records per page.
string
Filter by agent name.
integer
Filter by marketing campaign id.
integer
Minimum call duration in seconds.
string
Return items created after this time (exclusive). RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified after this time (exclusive). RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Filter by the agent’s external id.
boolean
Filter by whether the agent is external.
string
Filter by the caller’s phone number.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Filter by the phone number that was called.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CAMPAIGN_CATEGORIESList marketing campaign categories in ServiceTitan, one page per call. Categories group campaigns; they are not pricebook categories.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, Name.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CAMPAIGN_COSTSList monthly campaign cost records in ServiceTitan across all campaigns, one page per call, filtered by year, month or campaign. Each record holds a daily cost for one campaign and month.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Date (Year + Month).
integer
Return only cost records of this calendar year, e.g. 2025.
integer
Return only cost records of this month, 1 to 12.
integer
Number of records per page.
integer
Return only cost records of this campaign id.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CAMPAIGN_COSTS_FOR_CAMPAIGNList the monthly cost records of one marketing campaign in ServiceTitan, one page per call. Use LIST_CAMPAIGN_COSTS to read costs across all campaigns.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Date (Year + Month).
integer
Return only cost records of this calendar year, e.g. 2025.
integer
Return only cost records of this month, 1 to 12.
integer
Number of records per page.
integer
required
Id of the marketing campaign.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CAMPAIGNSList marketing campaigns in ServiceTitan, one page per call, filtered by name, tracking phone number, ids or dates. Only active campaigns are returned unless active is set to False or Any.

Input Parameters

array
Return only the records with these ids. Maximum 50; sent comma-separated.
string
Filters records by name (case-insensitive “contains” operation).
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return campaigns that use this tracking phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CAPACITY_WARNINGSList all capacity awareness warnings of ServiceTitan Marketing Ads, which flag campaigns whose business units are near their capacity threshold. Returns everything in one call; it takes no filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CLIENT_SPECIFIC_PRICING_RATE_SHEETSList client-specific pricing rate sheets in the ServiceTitan pricebook, each with its per-SKU price exceptions. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the rate sheets to return, sent comma-separated. The spec documents no maximum for this operation.
integer
Page number to return, starting at 1.
string ("True" | "Any" | "False")
Filter by active status: True (active only), False (inactive only), Any (both). The spec does not document the default for this operation.
integer
Number of records per page.
string
Text to search rate sheets by. The spec does not document which fields are searched.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CONTACT_METHOD_PREFERENCESList the communication preferences set on one contact method in ServiceTitan. Returns the full list in one call; it is not paged.

Input Parameters

string
required
GUID of the contact, from LIST_CONTACTS.
string
required
GUID of the contact method, from LIST_CONTACT_METHODS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CONTACT_METHODSList contact methods across ServiceTitan contacts, one page per call. Pass contact_id for one contact, or filter across contacts by value, type, reference id, or date.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("Phone" | "MobilePhone" | "Email" | "Fax")
Filter by contact method type: Phone, MobilePhone, Email or Fax.
string
Filter by the phone number, email address or fax number.
integer
Number of records per page.
string
Return only contact methods of the contact with this GUID.
string
Filters by reference ID.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CONTACT_PREFERENCE_TYPESList the communication preference types that can be set on a contact method in ServiceTitan, with each one’s name and data type. Returns the full list in one call; it is not paged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CONTACT_RELATIONSHIPSList the customers, locations and bookings a contact is linked to in ServiceTitan, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: ID, ModifiedOn, CreatedOn.
integer
Number of records per page.
string
required
GUID of the contact, from LIST_CONTACTS.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
Filters by related entity id.
string ("customer" | "location" | "booking")
Filter by relationship type slug: customer, location or booking.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("Customer" | "Location" | "Booking")
Filter by relationship type name: Customer, Location or Booking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CONTACTSList contacts (person records with name and title) in ServiceTitan, one page per call. These are the GUID-keyed contacts; for the phone and email entries on a customer use LIST_CUSTOMER_CONTACTS.

Input Parameters

string
Filters by contact name.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string
Filters by contact title.
integer
Number of records per page.
string
Filter by archived status. The spec types this as a string and lists no values; ‘true’ and ‘false’ are the expected ones.
string
Filters by external reference ID.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CONTACTS_FOR_RELATIONSHIPList the contacts in ServiceTitan attached to one relationship id, one page per call. Relationship ids come from LIST_CONTACT_RELATIONSHIPS.

Input Parameters

string
Filters by contact name.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string
Filters by contact title.
integer
Number of records per page.
string
Filter by archived status. The spec types this as a string and lists no values; ‘true’ and ‘false’ are the expected ones.
string
Filters by external reference ID.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
Id of the contact relationship, from LIST_CONTACT_RELATIONSHIPS. The spec types this as an integer, while LIST_CONTACT_RELATIONSHIPS returns GUID ids and integer related_entity_id values; which one is expected here is unverified.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CREDIT_MEMO_CUSTOM_FIELD_TYPESList the custom field type definitions available for credit memos in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_CREDIT_MEMO_CUSTOM_FIELDS.

Input Parameters

string
Return records whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CREDIT_MEMO_ITEMSList credit memo line items across credit memos in ServiceTitan, one page per call. Pass credit_memo_ids with one ID for a single credit memo or a provider-formatted multi-ID string for several; without it, items of every credit memo are returned.

Input Parameters

integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return credit memo items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Credit memo ID or provider-formatted ID string whose items to return. For one credit memo, pass its decimal ID as a string. The provider spec does not document the separator for multiple IDs.
string
Business unit ids to filter by. The spec types this as one string and does not document its format for more than one id.
string
Return credit memo items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CREDIT_MEMOSList customer credit memos in ServiceTitan, one page per call. Filter by applied invoices, dates, status, batch, business unit, total, balance or custom fields.

Input Parameters

array
List of credit memo ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Return only credit memos in the accounting batch with this id.
array
Return only records with one of these transaction statuses; every status is included when left out.
integer
Number of records per page.
string
Return credit memos dated before this date. Date in YYYY-MM-DD form, e.g. 2025-01-31.
string
Return only credit memos in the accounting batch with this number.
object
Custom field name-value filters, up to 50. Each entry is sent as customField.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return credit memos applied to an invoice before this date. Date in YYYY-MM-DD form, e.g. 2025-01-31.
string
Return credit memos created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return credit memos modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return credit memos dated on or after this date. Date in YYYY-MM-DD form, e.g. 2025-01-31.
string
Business unit ids to filter by. The spec types this as one string and does not document its format for more than one id.
string
Return credit memos applied to an invoice on or after this date. Date in YYYY-MM-DD form, e.g. 2025-01-31.
string
Return credit memos created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
number
Amount to compare each credit memo’s total against; use together with total_filter_comparer.
string
Return credit memos modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
number
Amount to compare each credit memo’s remaining balance against; use together with balance_filter_comparer.
string ("And" | "Or")
Operator between custom field filters: And or Or. Default And.
string ("Equal" | "NotEqual" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual")
How to compare the total with total_filter_amount.
string
Return only credit memos applied to these invoice ids. The spec types this as one string and does not document its format for more than one id.
string ("Equal" | "NotEqual" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual")
How to compare the balance with balance_filter_amount.
string
Return only credit memos applied to the invoice with this reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CUSTOMER_CONTACTSList contact entries for one or more ServiceTitan customers, or by modified-date range, one page per call. Pass one customer ID for the single-customer case. A location’s contacts are separate records; use LIST_LOCATION_CONTACTS for them.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
array
Return contact entries for one or more customer IDs. Sent comma-separated.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return entries modified before this time. One of customer_ids, modified_before or modified_on_or_after must be sent. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return entries modified on or after this time. One of customer_ids, modified_before or modified_on_or_after must be sent. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CUSTOMER_CUSTOM_FIELD_TYPESList the custom field types defined for customers in ServiceTitan, one page per call. Use it to find the type_id needed when setting custom_fields on a customer.

Input Parameters

string
Filters records by name (case-insensitive “contains” operation).
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. The sortable fields are not documented for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CUSTOMER_NOTESList the notes on one customer in ServiceTitan, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
Id of the customer.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. The spec text for this operation says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_CUSTOMERSList customers in ServiceTitan, one page per call, filtered by name, address, phone, ids or dates. Only active customers are returned unless active is set to False or Any.

Input Parameters

array
Return only the records with these ids. Maximum 50; sent comma-separated.
string
Returns customer records by zip.
string
Returns customer records by city.
string
Return customers with this name.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string
Returns customer records by unit.
string
Return customers that have a contact entry with this phone number.
string
Returns customer records by state.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string
Returns customer records by street.
string
Returns customer records by country.
number
Returns customer records by latitude.
number
Returns customer records by longitude.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Look up records by this external data key. external_data_values must be sent with it.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up, maximum 50. external_data_key must be sent with it. The spec types this as one string and does not document the separator.
string
Return items modified on or after this time. The spec text for this operation says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return only records that carry external data written under this application GUID.
boolean
Set true so that accounting changes such as balance adjustments do not count as modifications for modified_before and modified_on_or_after.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_DYNAMIC_VALUE_SET_VALUESList the allowed values of a report parameter’s dynamic value set in ServiceTitan, as rows of key and display name. Use it when a report’s parameter description gives a dynamic_set_id instead of a fixed list of values.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
required
Id of the dynamic value set, taken from a report parameter’s definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_EMPLOYEE_PAYROLLSList the payrolls (pay period records) of one office employee in ServiceTitan, one page per call. Use LIST_TECHNICIAN_PAYROLLS for a technician.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. The spec does not list the sortable fields for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string ("Pending" | "Expired" | "Approved" | "Paid" | "Locked")
Return only payrolls with this status.
integer
Number of records per page.
integer
required
Id of the office employee.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payrolls whose period ends on or before this time. The spec text says ‘before’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payrolls whose period starts on or after this time. The spec text says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payrolls approved on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_EMPLOYEESList employees in ServiceTitan, the office staff such as CSRs, dispatchers and bookkeepers, filtered by name, email or user id. Field technicians are a separate resource.

Input Parameters

array
Return only the employees with these ids. Maximum 50; sent comma-separated.
string
Filter by name; case-insensitive ‘contains’ match.
integer
Page number to return, starting at 1.
string
Filters records by email (exact match).
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string
Look up employees by several user ids, maximum 50. The spec types this as one string and does not document the separator.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_EQUIPMENT_SYSTEMSList equipment systems in ServiceTitan, the named groups of installed equipment at a customer location (for example one HVAC system), filtered by location or date range. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the equipment systems to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: ID, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string
Filter by location IDs. The spec types this as one string and does not document the format for several ids.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return equipment systems created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return equipment systems modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return equipment systems created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return equipment systems modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_EQUIPMENT_TYPESList the equipment types defined in ServiceTitan for classifying installed equipment, filtered by name or date range. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the equipment types to return. List of ids, max 50, sent comma-separated.
string
Return equipment types whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: ID, Name, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return equipment types created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return equipment types modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return equipment types created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return equipment types modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_ESTIMATE_ITEMSList estimate line items in ServiceTitan across estimates, or for one estimate when estimate_id is given. Returns one page per call.

Input Parameters

array
Return only the items with these ids. Maximum 50; sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. The sortable fields are not documented for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
integer
Return only the items of this estimate.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_ESTIMATESList estimates in ServiceTitan, filtered by job, project, location, seller, status, total amount, or sold/created/modified time. Returns one page per call.

Input Parameters

array
Return only the estimates with these ids. Maximum 50; sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. The spec does not list the sortable fields for sort; the deprecated order_by names Id, CreatedOn, ModifiedOn and SoldOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Filter by job id.
string
Filter by estimate status, for example Open, Sold or Dismissed. The accepted values are not listed in the spec for this filter.
string ("Id" | "CreatedOn" | "ModifiedOn" | "SoldOn")
Deprecated, use sort. Field to sort by: Id, CreatedOn, ModifiedOn or SoldOn.
integer
Number of records per page.
string
Filter by job number (the human-readable number, not the job id).
integer
Filter by project id.
string
Return estimates sold after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Filter by the id of the technician credited with the sale.
number
Return estimates whose total is less than this amount.
integer
Filter by service location id.
string
Return estimates sold before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to have total_count filled in the response; otherwise it is null.
number
Return estimates whose total is greater than this amount.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("asc" | "desc")
Deprecated, use sort. Sort direction: asc or desc.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Filter by the id of the employee credited with the sale.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_ESTIMATE_STATUS_CHANGESReturn the status change history of one estimate in ServiceTitan, each with its UTC timestamp. Not paged.

Input Parameters

integer
required
Id of the estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_ESTIMATE_TEMPLATESList estimate templates in ServiceTitan, the reusable sets of pricebook items that estimates and proposal templates are built from. Returns one page per call.

Input Parameters

integer
Page number to return, starting at 1.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_EXPENSE_TRANSACTION_CUSTOM_FIELD_TYPESList the custom field type definitions available for expense transactions in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_EXPENSE_TRANSACTION_CUSTOM_FIELDS.

Input Parameters

string
Return records whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_EXPENSE_TRANSACTIONSList expense transactions, such as card expenses, in ServiceTitan, one page per call. Filter by number, vendor name, employee, status, source system, cost or transaction date; NotSet is not an accepted expense status filter.

Input Parameters

array
List of expense transaction ids to return, sent comma-separated. The spec documents no maximum for this operation.
integer
Page number to return, starting at 1.
string
Filter by expense transaction number (partial match).
string
Filter expenses with transaction date before this date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Filter by specific batch ID.
number
Filter expenses with total cost less than or equal to this value.
number
Filter expenses with total cost greater than or equal to this value.
string
Filter expenses with transaction date on or after this date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Number of records per page.
string
Filter by job number (partial match).
integer
Filter by the employee associated with the expense.
string
Filter by vendor name (partial match).
integer
Filter by batch number.
object
Custom field name-value filters, up to 50. Each entry is sent as customField.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
array
Filter by sync status values.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Return only expenses with one of these statuses. Do not pass NotSet: it is rejected with 400.
array
List of originating systems to filter by (e.g. Ramp, Manual), sent comma-separated.
array
List of business unit IDs to filter by, sent comma-separated.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("And" | "Or")
Operator between custom field filters: And or Or. Default And.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_FINDING_ATTACHMENTSList the attachments of one ServiceTitan finding, by finding id. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the finding attachments to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: ID.
integer
Number of records per page.
integer
required
Id of the finding that owns the attachment.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return finding attachments created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return finding attachments created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_FINDINGSList findings in ServiceTitan, the issues or observations recorded at customer locations, filtered by location, installed equipment, source job, or date range. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the findings to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: ID, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
integer
Id of the customer location to filter by.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Id of the job where the finding was discovered.
string
Return findings created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return findings modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return findings created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return findings modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the installed equipment to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_FORMSList form definitions in ServiceTitan, filtered by name, published status, or whether they have conditional logic or triggers. Returns the forms themselves, not what people filled in.

Input Parameters

array
List of form ids to look up, sent comma-separated.
string
Filter by form name.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The sortable fields are not documented for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string ("Any" | "Published" | "Unpublished")
Filter by publication status: Any, Published or Unpublished.
integer
Number of records per page.
boolean
Filter by whether the form has triggers.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Filter by whether the form has conditional logic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_FORM_SUBMISSIONSList filled-in form submissions in ServiceTitan with their answers, filtered by form, status, submitter, submission time, or the record the form is attached to (job, customer, location and so on).

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, SubmittedOn, CreatedBy.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
array
Filter by the specific records the form is attached to, as a list of {type, id}. Sent in the documented indexed form: owners[0].type=Location&owners[0].id=2689281.
string ("Started" | "Completed" | "Any")
Filter by submission status: Started, Completed or Any.
array
List of form ids to filter by, sent comma-separated.
integer
Number of records per page.
string ("Job" | "Call" | "Customer" | "Location" | "Equipment" | "Technician" | "JobAppointment" | "Membership" | "Truck")
Filter by the kind of record the form is attached to: Job, Call, Customer, Location, Equipment, Technician, JobAppointment, Membership or Truck.
integer
Filter by the id of the user who created the submission.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return submissions before this time. The spec describes this filter as the submission modified date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return submissions on or after this time. The spec describes this filter as the submission modified date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_GL_ACCOUNTSList general ledger (GL) accounts in ServiceTitan, one page per call. Filter by ids, names, numbers, types, subtypes, description text, source or active status; only active accounts are returned unless active is set.

Input Parameters

array
List of general ledger account ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
array
List of account names, max 50, sent comma-separated.
array
List of account types, max 50, sent comma-separated.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string ("Undefined" | "AccountingSystem" | "ManuallyCreated" | "PublicApi")
Return only accounts created from this source.
array
List of account numbers, max 50, sent comma-separated.
array
List of account subtypes, max 50, sent comma-separated.
integer
Number of records per page.
string
A substring that must be contained in the account description.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to return only Sage Intacct group accounts.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to return only Sage Intacct bank accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_GL_ACCOUNT_TYPESList general ledger account types in ServiceTitan, one page per call. Use it to find the type names accepted when creating or filtering GL accounts.

Input Parameters

array
List of general ledger account type ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
array
List of account type names, max 50, sent comma-separated.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_GROSS_PAY_ITEMSList gross pay items (earnings such as timesheet time, bonuses, salary and reimbursements) in ServiceTitan, one page per call. Filter by employee, payroll or date to get the earnings of a pay period. These are computed earnings, not the raw clock times in LIST_PAYROLL_JOB_TIMESHEETS or LIST_NON_JOB_TIMESHEETS.

Input Parameters

integer
Page number to return, starting at 1.
string
Sort order, sent unchanged. The spec says only that it applies sorting by the specified fields: it documents neither the syntax nor the sortable fields for this operation. Other ServiceTitan lists use +Field ascending, -Field descending.
integer
Number of records per page.
integer
Return only gross pay items of the employee or technician with this id; use with employee_type.
string
Payroll id or ids whose gross pay items to return, as one string sent unchanged. The spec types this parameter as a string and does not document the separator for several ids.
string ("Technician" | "Employee")
Whether employee_id refers to a Technician or an Employee.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return gross pay items dated on or after this time. The spec text says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return gross pay items dated on or before this time. The spec text says ‘before’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INSTALLED_EQUIPMENTList equipment installed at ServiceTitan customer locations, filtered by location, equipment system, parent, or date range. For catalog equipment in the pricebook use LIST_PRICEBOOK_EQUIPMENT. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the installed equipment records to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
array
Return equipment whose direct parent is any of these entries. Each entry needs both id and type (Equipment or System); types may be mixed. Sent as parents[0].id, parents[0].type, and so on.
integer
Number of records per page.
boolean
True returns equipment that has a parent; false returns top-level equipment.
boolean
True returns equipment that belongs to a system; false returns unassigned equipment.
array
Ids of equipment systems. Returns equipment at any level attached to these systems. Sent comma-separated.
string
Ids of the locations to filter by. The spec types this as one string and does not document its format.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return installed equipment records created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return installed equipment records modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return installed equipment records created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return installed equipment records modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INSTALLED_EQUIPMENT_CUSTOM_FIELD_TYPESList the custom field types defined for ServiceTitan installed equipment, with each type’s data type and options. The descending flag is required. Returns one page per call; request the next page while has_more is true.

Input Parameters

integer
Page number to return, starting from 1. Always sent.
string
Name of the field to sort by. The spec does not list the sortable fields.
integer
Number of records per page. Defaults to 50. Always sent.
boolean
required
Set true to sort descending, false for ascending.
string
Return installed equipment custom field types created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return installed equipment custom field types modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return installed equipment custom field types created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return installed equipment custom field types modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INTACCT_BUSINESS_UNIT_MAPPINGSList how ServiceTitan business units map to Sage Intacct locations, departments and classes. Only useful for tenants with the Intacct accounting integration; page, page_size and include_total are all required here.

Input Parameters

array
Business unit ids to look up. Sent as a repeated query parameter (ids=1&ids=2); the spec types it as an array and does not document a maximum.
integer
required
Page number to return. Required for this operation. The spec allows 0 as the lowest value and does not say whether the first page is 0 or 1.
integer
required
Number of records per page, 1 to 500. Required for this operation.
boolean
required
Set true to also return total_count. Required for this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVENTORY_ADJUSTMENTSList inventory adjustments in ServiceTitan, filtered by type, inventory location, business unit, invoice, batch, sync status, or date range. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the inventory adjustments to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string
Return inventory adjustments with this number.
integer
Id of the batch to filter by.
integer
Number of records per page.
string
Return adjustments with date before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Ids of the invoices to filter by. The spec types this as one plain string and the format for several values is undocumented.
object
Custom field name-value filters. Each entry is sent as customFields.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Sync statuses to filter by: Pending, Posted or Exported (the spec’s Inventory.V2.SyncStatus values). The spec types this as one plain string and the format for several values is undocumented.
string
Return inventory adjustments created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return inventory adjustments modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Adjustment types to filter by: Adjustment, BeginningBalance, InventoryReturn, InventoryCount, AutoConsume, ReturnToWarehouse, Consignment, ConsignmentInventoryCount, ReturnToVendor, IntracompanyTransferIncoming, IntracompanyTransferOutgoing. The spec types this as one plain string and the format for several values is undocumented.
string
Return adjustments with date on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return inventory adjustments with this reference number.
string
Ids of the business units to filter by. The spec types this as one plain string and the format for several values is undocumented.
string
External data key to look up. external_data_values must also be given.
string
Return inventory adjustments created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up, maximum 50. external_data_key must also be given. The spec types this as one plain string and the format for several values is undocumented.
string
Return inventory adjustments modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("And" | "Or")
Operator between custom field filters: And or Or.
string
Ids of the inventory locations to filter by. The spec types this as one plain string and the format for several values is undocumented.
string
Application GUID whose external data should be returned with each record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVENTORY_BILL_CUSTOM_FIELD_TYPESList the custom field type definitions available for inventory bills in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_INVENTORY_BILL_CUSTOM_FIELDS.

Input Parameters

string
Return records whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVENTORY_BILLSList inventory bills (vendor bills created from purchase orders and receipts) in ServiceTitan, one page per call. Filter by bill number, purchase order, job number, sync status, cost or dates; bills are read-only apart from custom fields and the exported mark.

Input Parameters

array
List of inventory bill ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
End of the bill date range to return. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Return only inventory bills in the accounting batch with this id.
number
Highest cost of the bills to return.
number
Lowest cost of the bills to return.
string ("NotSet" | "Procurement" | "ApBill" | "RecurringBill")
Filter by bill type: NotSet, Procurement, ApBill or RecurringBill.
string
Start of the bill date range to return. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Number of records per page.
string
Filter by job number. The spec does not say how the value is matched.
string
Filter by bill number. The spec does not say how the value is matched.
integer
Return only inventory bills in the accounting batch with this number.
object
Custom field name-value filters, up to 50. Each entry is sent as customField.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
array
Return only inventory bills with one of these accounting sync statuses: Pending, Posted, Exported, PostedAndExported.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Business unit ids to filter by, as one string. The spec types this as a plain string and the format for several ids is undocumented.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Purchase order types to filter by, as one string. The spec types this as a plain string; the format for several types and the accepted values are undocumented.
string ("And" | "Or")
Operator between custom field filters: And or Or. Default And.
string
Filter by purchase order number. The spec does not say how the value is matched.
string
Return bills reconciled before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return bills reconciled on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("NoDiscrepancy" | "Discrepancy")
Filter by three-way match discrepancy: NoDiscrepancy or Discrepancy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVENTORY_RECEIPTSList inventory receipts in ServiceTitan, the records of items received against purchase orders, filtered by purchase order, vendor, bill, inventory location, or received date. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the inventory receipts to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string
Return the inventory receipt with this number.
integer
Id of the bill to filter by.
integer
Id of the accounting export batch to filter by.
integer
Number of records per page.
string
Ids of the vendors to filter by. The spec types this as one plain string and the format for several values is undocumented.
object
Custom field name-value filters. Each entry is sent as customFields.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Sync statuses to filter by: Pending, Posted or Exported (the spec’s Inventory.V2.SyncStatus values). The spec types this as one plain string and the format for several values is undocumented.
string
Return inventory receipts created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return inventory receipts modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return receipts with received date before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Ids of the business units to filter by. The spec types this as one plain string and the format for several values is undocumented.
string
Ids of the purchase orders to filter by. The spec types this as one plain string and the format for several values is undocumented.
string
Return inventory receipts created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return inventory receipts modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return receipts with received date on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("And" | "Or")
Operator between custom field filters: And or Or.
string
Vendor invoice number to filter by.
string
Ids of the inventory locations to filter by. The spec types this as one plain string and the format for several values is undocumented.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVENTORY_RETURNSList vendor returns in ServiceTitan inventory, filtered by vendor, purchase order, job, inventory location, business unit, or return date. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the vendor returns to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Id of the job to filter by.
string
Return the vendor return with this number.
integer
Id of the accounting export batch to filter by.
integer
Number of records per page.
string
Ids of the vendors to filter by. The spec types this as one plain string and the format for several values is undocumented.
object
Custom field name-value filters. Each entry is sent as customFields.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Sync statuses to filter by: Pending, Posted or Exported (the spec’s Inventory.V2.SyncStatus values). The spec types this as one plain string and the format for several values is undocumented.
string
Return vendor returns created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return vendor returns modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return vendor returns with this reference number.
string
Ids of the business units to filter by. The spec types this as one plain string and the format for several values is undocumented.
string
External data key to look up. external_data_values must also be given.
integer
Id of the purchase order to filter by.
string
Return vendor returns with return date before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return vendor returns created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up, maximum 50. external_data_key must also be given. The spec types this as one plain string and the format for several values is undocumented.
string
Return vendor returns modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("And" | "Or")
Operator between custom field filters: And or Or.
string
Ids of the inventory locations to filter by. The spec types this as one plain string and the format for several values is undocumented.
string
Return vendor returns with return date on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVENTORY_RETURN_TYPESList vendor return types in ServiceTitan inventory; a return type id is required to create a return. The active_only flag is required. Returns one page per call; request the next page while has_more is true.

Input Parameters

string
Filter by return type name. The spec does not say whether the match is exact or partial.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The spec does not list the sortable fields.
integer
Number of records per page.
boolean
required
Required. Set true to return only active return types, false to include inactive ones.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return return types created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return return types modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return return types created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return return types modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVENTORY_TEMPLATESList ServiceTitan inventory templates with their items, each item carrying a minimum and maximum quantity. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the inventory templates to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order. The spec says only that it sorts by the specified fields; the format and the sortable fields are undocumented for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return inventory templates created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return inventory templates modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return inventory templates created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return inventory templates modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVENTORY_TRANSFERSList inventory transfers in ServiceTitan, the movements of stock between inventory locations, filtered by status, source or destination location, transfer type, job, or date. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the inventory transfers to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn, Date.
string
Return the inventory transfer with this number.
string
Ids of the jobs associated with the transfer. The spec types this as one plain string and the format for several values is undocumented.
integer
Id of the batch to filter by.
string
Transfer statuses to filter by. The spec does not list the accepted values for this filter. The spec types this as one plain string and the format for several values is undocumented.
integer
Number of records per page.
string
Return transfers with date before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
object
Custom field name-value filters. Each entry is sent as customFields.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Sync statuses to filter by: Pending, Posted or Exported (the spec’s Inventory.V2.SyncStatus values). The spec types this as one plain string and the format for several values is undocumented.
string
Return inventory transfers created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return inventory transfers modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Ids of the destination (to) inventory locations to filter by. The spec types this as one plain string and the format for several values is undocumented.
string
Return transfers with date on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return inventory transfers with this reference number.
string
External data key to look up. external_data_values must also be given.
string
Ids of the source (from) inventory locations to filter by. The spec types this as one plain string and the format for several values is undocumented.
string
Ids of the transfer types to filter by. The spec types this as one plain string and the format for several values is undocumented.
string
Return inventory transfers created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up, maximum 50. external_data_key must also be given. The spec types this as one plain string and the format for several values is undocumented.
string
Return inventory transfers modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("And" | "Or")
Operator between custom field filters: And or Or.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVOICE_CUSTOM_FIELD_TYPESList the custom field type definitions available for invoices in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_INVOICE_CUSTOM_FIELDS.

Input Parameters

string
Return records whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVOICESList customer invoices in ServiceTitan, one page per call; every invoice type (job, membership, project, point of sale, adjustment) comes from this one tool. Invoices of every status are returned unless statuses is set; the spec does not document which active state applies when active_state is left out.

Input Parameters

array
Return only the invoices with these ids; sent comma-separated. The spec documents no maximum for this operation.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Return only invoices linked to the job with this id.
string
Return only invoices with this reference number.
integer
Return only invoices in the accounting batch with this id.
string
Invoice field to order the list by. The spec does not list the accepted field names.
array
Return only records with one of these transaction statuses; every status is included when left out.
integer
Number of records per page.
string
Return only invoices linked to the job with this number.
number
Return invoices with a total less than or equal to this value.
integer
Return only invoices for the customer with this id.
string ("ActiveOnly" | "InactiveOnly" | "All")
Filter by active state: ActiveOnly, InactiveOnly, or All. The spec does not document which one applies when this is left out.
integer
Return only invoices in the accounting batch with this number.
object
Custom field name-value filters, up to 50. Each entry is sent as customField.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
number
Return invoices with a total greater than or equal to this value.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Return only invoices assigned to one of these user ids.
string
Return invoices with a due date before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Return only invoices with one of these review statuses.
integer
Return only adjustment invoices that adjust the invoice with this id.
integer
Return only invoices of the business unit with this id.
string
Return invoices with an invoice date before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Sort direction for order_by: desc or descending sorts descending, anything else ascending.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return invoices with a due date on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return invoices with an invoice date on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
number
Amount to compare each invoice’s balance against; use together with balance_filter_comparer.
string ("And" | "Or")
Operator between custom field filters: And or Or. Default And.
array
Return only invoices of one of these configurations (invoice kinds).
string ("Equals" | "NotEquals" | "Greater" | "Less")
How to compare the balance with balance_filter_amount.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVOICE_TASKSList the workflow tasks attached to one invoice in ServiceTitan, one page per call. These are invoice tasks created from templates, not Task Management tasks.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page. This tool sends 50 when it is left out; the spec documents no default for this operation.
integer
required
Id of the invoice.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_INVOICE_TEMPLATESLook up membership invoice templates in ServiceTitan by id (ids is required, max 50). It cannot enumerate all templates: to browse every template use EXPORT_INVOICE_TEMPLATES; otherwise take ids from a customer membership’s billing template or a recurring service’s invoice template.

Input Parameters

array
required
Ids of the invoice templates to look up. List of ids, max 50, sent comma-separated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOB_ATTACHMENTSList files attached to a specified ServiceTitan job, with optional creation-date filters, sorting, and pagination. OAuth access requires the tn.frm.jobs:r scope.

Input Parameters

integer
Page number to return, starting at 1. Not sent unless set; the spec documents no default for this operation.
string
Sort order: +Field ascending, -Field descending. The sortable fields are not documented for this operation.
integer
required
Id of the job whose attachments to list.
integer
Number of records per page. Not sent unless set; the spec documents no default and no maximum for this operation, and no has_more flag in the response.
boolean
Documented query parameter of this operation. The response has no documented schema, so where a total count appears is not known.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOB_CANCELED_LOGSList the canceled-log entries of one ServiceTitan job, one page per call; each entry records a cancellation of that job.

Input Parameters

integer
Page number to return, starting at 1.
integer
required
ID of the job.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOB_CANCEL_REASONSList the cancel reasons configured in ServiceTitan, one page per call. Use it to pick the reason_id for Cancel Job; it does not say why a given job was canceled.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only), False (inactive only), Any (both). When omitted, this operation returns both active and inactive items.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOB_CUSTOM_FIELD_TYPESList the custom field types available for ServiceTitan jobs, one page per call. Use the returned IDs as type_id in the custom_fields of Create Job or Update Job.

Input Parameters

string
Filters records by name (case-insensitive “contains” operation)
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOB_HOLD_REASONSList the hold reasons configured in ServiceTitan, one page per call. Use it to pick the reason_id for Hold Appointment; it does not say why a given job is on hold.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only), False (inactive only), Any (both). When omitted, this operation returns both active and inactive items.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOB_NOTESList the notes on one ServiceTitan job, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
integer
required
ID of the job.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOBSList ServiceTitan jobs, one page per call, filtered by status, customer, location, project, technician, job type or date ranges for creation, modification, completion and appointments.

Input Parameters

array
Return only the records with these IDs. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn, Priority.
string ("Low" | "Normal" | "High" | "Urgent")
Filter by job priority.
integer
Number of records per page.
integer
Filters by booking ID that resulted in this job.
integer
Filters by job’s invoice ID.
string
Filter by job number.
string ("Scheduled" | "Dispatched" | "InProgress" | "Hold" | "Completed" | "Canceled")
Filters by job status.
integer
Filters by project ID.
integer
Filters by the technician who sold the job.
integer
Filters by job’s campaign ID.
integer
Filters by job’s customer ID.
integer
Filters by job type ID.
integer
Filters by job’s location ID.
array
Filters by estimate IDs that are related to the job. List of ids, sent comma-separated.
array
Return jobs that have at least one of provided Tag Type assigned. List of ids, sent comma-separated.
array
Return jobs that have at least one of provided equipment items attached. List of ids, sent comma-separated.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Return jobs if technician is assigned to any appointment.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Filters by job’s business unit ID.
string
Return jobs that are completed before a certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Performs lookup by external data key, external_data_values must also be provided.
string ("Scheduled" | "Dispatched" | "Working" | "Hold" | "Done" | "Canceled")
Filters by appointment status. Return a job if it has any appointment with the specified status.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Performs lookup by external data values (maximum 50), external_data_key must also be provided. The spec types this as one string and does not document the separator.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return jobs completed on or after this date-time. The spec text says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
If set to true, return jobs that have unused appointments.
integer
Filters by the sold estimate ID from which the job was created.
string
Return jobs that have any appointment starting before this date-time; the spec text says ‘after’, the parameter name is followed. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return jobs that have any appointment starting on or after this date-time. The spec text says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
If this GUID is provided, external data corresponding to this application GUID will be returned. GUID string.
string
Return jobs whose first appointment starts before date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return jobs whose first appointment starts on or after date-time. Use with first_appointment_starts_before to find jobs whose first appointment is within the specified date range. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOB_TYPESList ServiceTitan job types, one page per call, filtered by name, priority, duration or dates. Use it to find the job_type_id for Create Job.

Input Parameters

array
Return only the records with these IDs. List of ids, max 50, sent comma-separated.
string
Filters by job type name.
integer
Page number to return, starting at 1.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string ("id" | "modifiedOn" | "createdOn")
Field to order results by. Supported: id, modifiedOn, createdOn. This operation uses order_by and order_by_direction instead of sort.
string
Filter by the job type’s priority (level of urgency).
integer
Number of records per page.
integer
Maximum job type duration, in seconds.
integer
Minimum job type duration, in seconds.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("asc" | "ascending" | "desc" | "descending")
Order direction. Supported: asc or ascending, desc or descending.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
If this guid is provided, external data corresponding to this application guid will be returned. GUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOURNAL_ENTRIESList journal entries in ServiceTitan, one page per call (page_size max 500). Filter by posting, transaction or export dates, number range, status, sync status, transaction type, names, business units or reference numbers or custom fields.

Input Parameters

array
List of journal entry ids (GUID strings) to return, max 50, sent comma-separated.
string
Return journal entries whose name contains this text.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Number, Name, Status, CreatedOn, ExportedOn, ExportedBy, PostDate.
array
Return only journal entries with one of these posting statuses: Open, Closed.
integer
Return journal entries with a number less than or equal to this value.
integer
Number of records per page (50 by default, maximum 500).
string
Return journal entries posted on or before this date; the time part is ignored. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
List of transaction reference numbers to match, max 50, sent comma-separated.
array
List of user ids; return journal entries exported by any of them, max 50, sent comma-separated.
string
Return journal entries exported on or before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Return journal entries with a number greater than or equal to this value.
string
Return journal entries posted on or after this date; the time part is ignored. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return journal entries containing a transaction for a vendor whose name contains this text.
object
Custom field name-value filters, up to 5. Each entry is sent as customField.name=value. Null values are not supported by this action.
string
Return journal entries containing a transaction for a customer whose name contains this text.
string ("IncludeExceptNotSynced" | "Include" | "Exclude")
Whether journal entries with no lines are returned: IncludeExceptNotSynced, Include or Exclude. Ignored when ids is given.
string
Return journal entries exported on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return journal entries containing a transaction for a customer location whose name contains this text.
array
Return only journal entries with one of these sync statuses: NotSynced, InProgress, Synced, OutOfSync, Error, Excluded.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
List of business unit IDs, max 50, sent comma-separated.
array
Return journal entries that contain at least one transaction of one of these types.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
List of service agreement IDs, max 50, sent comma-separated.
string
Return journal entries containing a transaction posted on or before this date; the time part is ignored. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return journal entries containing a transaction for an inventory location whose name contains this text.
string
Return journal entries containing a transaction posted on or after this date; the time part is ignored. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOURNAL_ENTRY_DETAILSList one journal entry’s amounts in ServiceTitan aggregated by GL account, business unit, transaction and pricebook item, one page per call (page_size max 500). Use LIST_JOURNAL_ENTRY_SUMMARY for totals per account only.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page (50 by default, maximum 500).
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
required
Id of the journal entry (a GUID string), from LIST_JOURNAL_ENTRIES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_JOURNAL_ENTRY_SUMMARYList one journal entry’s amounts in ServiceTitan aggregated by GL account and business unit, one page per call (page_size max 500). Use LIST_JOURNAL_ENTRY_DETAILS for the finer breakdown by transaction and pricebook item.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page (50 by default, maximum 500).
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
required
Id of the journal entry (a GUID string), from LIST_JOURNAL_ENTRIES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_LABOR_TYPESList payroll labor types in ServiceTitan, one page per call. A labor type classifies paid time and can map to a labor service in the pricebook.

Input Parameters

integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The spec does not list the sortable fields for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_LEAD_NOTESList the notes on one lead in ServiceTitan, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
integer
required
Id of the lead.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. The spec text for this operation says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_LEADSList leads in ServiceTitan, one page per call, filtered by status, customer, dates or the name and phone given on the lead. Use status Open to find leads that still need follow-up.

Input Parameters

array
Return only the records with these ids. Maximum 50; sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("Open" | "Dismissed" | "Converted")
Filter by lead status.
integer
Number of records per page.
string
Filter by the phone number given on the lead.
integer
Return only leads linked to this customer id.
boolean
True returns leads with no customer or whose customer has no job; false returns leads whose customer has a job. Omit to return all leads.
string
Filters by customer zip.
string
Filters by customer city.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Filters by customer state.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
True returns only leads with no customer or location record; false returns only leads that have them. Omit to return all leads.
string
Filter by the customer name given on the lead.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to have a permanent URL generated for each lead returned.
boolean
Set true to return only leads captured from a lead form; false to return only the others.
string
Return leads whose customer was created before this time. The spec text for this filter contradicts its name; the name is followed here. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return leads whose customer was created on or after this time. The spec text for this filter contradicts its name; the name is followed here. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return leads whose customer was modified on or after this time. The spec text for this filter contradicts its name; the name is followed here. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_LOCATION_CONTACTSList contact entries for one or more ServiceTitan locations, or by created or modified date range, one page per call. Pass one location ID for the single-location case. A customer’s contacts are separate records; use LIST_CUSTOMER_CONTACTS for them.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
array
Return contact entries for one or more location IDs. Sent comma-separated.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return entries modified before this time. One of location_ids or the date filters must be sent. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return entries modified on or after this time. One of location_ids or the date filters must be sent. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_LOCATION_CUSTOM_FIELD_TYPESList the custom field types defined for locations in ServiceTitan, one page per call. Use it to find the type_id needed when setting custom_fields on a location.

Input Parameters

string
Filters records by name (case-insensitive “contains” operation).
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. The sortable fields are not documented for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_LOCATION_LABOR_RATESList the hourly labor rates set per customer location and labor type in ServiceTitan, one page per call. Pass location_ids to limit the result to specific locations.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Location (sorts by the location id), CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string
Return location rates for the specified location ids. The spec types this as one string and does not document the format or the separator for more than one id.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_LOCATION_NOTESList the notes on one location in ServiceTitan, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
Id of the location.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. The spec text for this operation says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_LOCATIONSList locations in ServiceTitan, one page per call, filtered by customer, name, address, ids or dates. Only active locations are returned unless active is set to False or Any.

Input Parameters

array
Return only the records with these ids. Maximum 50; sent comma-separated.
string
Filter by the zip code of the location address.
string
Filter by the city of the location address.
string
Filter by location name.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string
Filter by the unit of the location address.
string
Filter by the state of the location address.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string
Filter by the street of the location address.
string
Filter by the country of the location address.
number
Filter by the latitude of the location address.
number
Filter by the longitude of the location address.
integer
Number of records per page.
integer
Return only locations that belong to this customer id.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Look up records by this external data key. external_data_values must be sent with it.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up, maximum 50. external_data_key must be sent with it. The spec types this as one string and does not document the separator.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return only records that carry external data written under this application GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_MEMBERSHIP_CUSTOM_FIELD_TYPESList the custom field types defined for customer memberships in ServiceTitan. Returns field definitions (id, name, data type), not the values stored on a membership.

Input Parameters

string
Filter by name; case-insensitive ‘contains’ match.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The sortable fields are not documented for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_MEMBERSHIPSList customer memberships in ServiceTitan, filtered by customer, status, duration, billing frequency or created/modified time. A customer membership is one customer’s instance of a membership type; use the membership types tools for the templates themselves.

Input Parameters

array
List of ids to look up, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The sortable fields are not documented for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string ("Active" | "Suspended" | "Expired" | "Canceled" | "Deleted")
Filters by membership status.
integer
Filter by membership duration in months. The spec says null selects ongoing memberships; this tool cannot send null, so that filter is not available here.
integer
Number of records per page.
string
Filter by customer ids. The spec types this as one string and does not document the separator.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("OneTime" | "Monthly" | "EveryOtherMonth" | "Quarterly" | "BiAnnual" | "Annual")
Filters by membership billing frequency.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_MEMBERSHIP_STATUS_CHANGESReturn the status change history of one customer membership in ServiceTitan. Not paged: every change for that membership comes back in one call.

Input Parameters

integer
required
Id of the customer membership.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_MEMBERSHIP_TYPE_DISCOUNTSList the discounts granted by one membership type in ServiceTitan. Not paged.

Input Parameters

integer
required
Id of the membership type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_MEMBERSHIP_TYPE_DURATION_BILLING_ITEMSList the duration and billing options of one membership type in ServiceTitan, with their prices. Each option’s id is the duration_billing_id needed to sell a membership. Not paged.

Input Parameters

string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
required
Id of the membership type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_MEMBERSHIP_TYPE_RECURRING_SERVICE_ITEMSList the recurring services included in one membership type in ServiceTitan. Not paged.

Input Parameters

integer
required
Id of the membership type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_MEMBERSHIP_TYPESList membership types in ServiceTitan, the templates that memberships are sold from. Discounts, duration/billing options, recurring services and tags are left out unless the matching include_ flag is true.

Input Parameters

array
List of ids to look up, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The sortable fields are not documented for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Filter by membership duration in months. The spec says null selects ongoing memberships, but this tool cannot send null; leave it out to send no duration filter.
integer
Number of records per page.
boolean
Whether tag type IDs associated with the membership type should be included in the result.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("OneTime" | "Monthly" | "EveryOtherMonth" | "Quarterly" | "BiAnnual" | "Annual")
Filters by membership billing frequency.
boolean
Whether discounts should be included in the result.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Whether duration/billing should be included in the result.
boolean
Whether recurring service types associated with the membership type should be included in the result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_NON_JOB_APPOINTMENTSList ServiceTitan non-job appointments (technician time blocked for non-customer activities), one page per call, filtered by technician, start range or timesheet code. For customer job visits use List Appointments.

Input Parameters

array
Return only the records with these IDs. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, ModifiedOn.
integer
Number of records per page.
boolean
Whether to return only active non-job appointments. This operation uses active_only instead of the active filter.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Return non-job appointments for this technician.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Return non-job appointments with this timesheet code.
string
Return non-job appointments that start on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return non-job appointments that start on or before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Whether the non-job appointment shows on the technicians schedule even if there is no timesheet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_NON_JOB_TIMESHEETSList non-job timesheets (time recorded against timesheet codes) in ServiceTitan, one page per call. Filter by employee_id, employee_type, dates or active status. Covers time not on a job; for dispatch-to-done time on job appointments use LIST_PAYROLL_JOB_TIMESHEETS.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
integer
Return only timesheets of the employee or technician with this id.
string ("Technician" | "Employee")
Return only timesheets of this kind of staff: Technician or Employee.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_OPT_OUTSReturn every phone number that has opted out of contact in ServiceTitan, with its opt-out type. Not paged; numbers come back in E.164 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYMENT_CUSTOM_FIELD_TYPESList the custom field type definitions available for payments in ServiceTitan, one page per call. Use it to find valid custom field names before setting them with UPDATE_PAYMENT_CUSTOM_FIELDS.

Input Parameters

string
Return records whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
Sort order. The spec gives this parameter no description and no sortable fields on this operation; other lists of this API use +Field ascending, -Field descending.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYMENTSList payments received from customers in ServiceTitan, one page per call. Filter by the invoices they were applied to, customer, deposit, paid date, status or total; use LIST_AP_PAYMENTS for payments made to vendors.

Input Parameters

array
List of payment ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending, e.g. -CreatedOn. The spec does not list the sortable fields for this operation.
integer
Return only payments in the accounting batch with this id.
string
Return only payments with these statuses. The payment statuses the spec documents are Pending, Posted and Exported. The spec types this as one string and does not document its format or separator, so the value is sent as given.
integer
Number of records per page.
number
Return payments with a total less than this value; whether the boundary itself is included is undocumented.
integer
Return only payments for the customer with this id.
string
Return only payments included in these bank deposit ids. The spec types this as one string and does not document its format or separator, so the value is sent as given.
string ("ActiveOnly" | "InactiveOnly" | "All")
Filter by active state: ActiveOnly (default), InactiveOnly, or All.
integer
Return only payments in the accounting batch with this number.
object
Custom field name-value filters, up to 50. Each entry is sent as customField.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return payments paid after this date-time; whether the boundary itself is included is undocumented. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
number
Return payments with a total greater than this value; whether the boundary itself is included is undocumented.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payments paid before this date-time; whether the boundary itself is included is undocumented. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("Undefined" | "JournalEntry" | "ReceivePayment")
Return only payments of this transaction type: Undefined, JournalEntry or ReceivePayment.
string
Return only payments of these business unit ids. The spec types this as one string and does not document its format or separator, so the value is sent as given.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("And" | "Or")
Operator between custom field filters: And or Or. Default And.
string
Return only payments applied to these invoice ids. The spec types this as one string and does not document its format or separator, so the value is sent as given.
string
Return only payments applied to the invoice with this reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYMENT_TERMSList payment terms (the due-date rules attached to invoices and bills) in ServiceTitan, one page per call. Payment terms are read-only through the API.

Input Parameters

array
List of payment term ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name, CreatedOn.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payment terms modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payment terms modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYMENT_TYPESList payment types (for example cash, check, credit card) in ServiceTitan, one page per call. Use it to find the type_id needed by UPDATE_PAYMENT.

Input Parameters

array
List of payment type ids to return, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYROLL_ACTIVITY_CODESList payroll activity codes (earning codes that map earnings to a payroll processor’s codes) in ServiceTitan, one page per call. These are not timesheet activities; use LIST_TIMESHEET_ACTIVITIES for recorded time.

Input Parameters

integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The spec does not list the sortable fields for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYROLL_ADJUSTMENTSList payroll adjustments (manually entered earnings or deductions) in ServiceTitan, one page per call. Filter by employee ids or posted date.

Input Parameters

integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The spec does not list the sortable fields for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
array
Return only adjustments of these employee ids. Sent comma-separated; the spec documents no maximum.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payroll adjustments posted on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payroll adjustments posted on or before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYROLL_JOB_SPLITSList payroll job splits across jobs in ServiceTitan, one page per call: one record per technician and job with that technician’s split. Pass job_ids with one ID for a single job or a provider-formatted multi-ID string for several jobs.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only), False (inactive only), Any (both). The spec documents no default for this operation.
string
Job ID or provider-formatted ID string whose job splits to return, sent unchanged. For one job, pass its decimal ID as a string. The provider spec does not document the separator for multiple IDs.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return job splits created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return job splits modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return job splits created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return job splits modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYROLL_JOB_TIMESHEETSList technician job timesheets across jobs in ServiceTitan (dispatch, arrive, cancel and done times), one page per call. job_ids limits the result to given jobs, but its format is not documented; use LIST_PAYROLL_JOB_TIMESHEETS_FOR_JOB for one job. Covers time on job appointments only; time on non-job codes (meetings, training) is in LIST_NON_JOB_TIMESHEETS, and paid earnings are in LIST_GROSS_PAY_ITEMS.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string
Ids of the jobs whose timesheets to return, as one string. The spec types this parameter as a string and documents neither its format nor its separator.
string
Return timesheets with a dispatch, arrive, cancel or done time before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Number of records per page.
string
Return timesheets with a dispatch, arrive, cancel or done time after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Return only timesheets of the technician with this id.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYROLL_JOB_TIMESHEETS_FOR_JOBList the technician timesheets recorded on one job in ServiceTitan (dispatch, arrive, cancel and done times), one page per call. Use LIST_PAYROLL_JOB_TIMESHEETS to read across jobs.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
required
Id of the job.
string
Return timesheets with a dispatch, arrive, cancel or done time before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Number of records per page.
string
Return timesheets with a dispatch, arrive, cancel or done time after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Return only timesheets of the technician with this id.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYROLLSList payrolls (one employee’s or technician’s pay period record) across all staff in ServiceTitan, one page per call. Filter by employee type, period dates, approval date or status.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. The spec does not list the sortable fields for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string ("Pending" | "Expired" | "Approved" | "Paid" | "Locked")
Return only payrolls with this status.
integer
Number of records per page.
string ("Technician" | "Employee")
Return only payrolls of this kind of staff: Technician or Employee.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payrolls whose period ends on or before this time. The spec text says ‘before’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payrolls whose period starts on or after this time. The spec text says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payrolls approved on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PAYROLL_SETTINGSList the payroll settings (hourly rate, hire date, manager, external payroll id) of employees and technicians in ServiceTitan, one page per call. Filter by employee type or active status.

Input Parameters

integer
Page number to return, starting at 1.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string ("Technician" | "Employee")
Return only settings of this kind of staff: Technician or Employee.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PRICEBOOK_CATEGORIESList pricebook categories in ServiceTitan, optionally only Services or Materials categories. Each category carries its nested subcategories. Returns one page per call; request the next page while has_more is true.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string ("Services" | "Materials")
Return only categories of this type: Services or Materials.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return pricebook categories created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return pricebook categories modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return pricebook categories created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return pricebook categories modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PRICEBOOK_DISCOUNTS_AND_FEESList discounts and fees in the ServiceTitan pricebook, with optional search text and category filters. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the discounts and fees to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Code, DisplayName, CreatedOn, ModifiedOn, Price, MemberPrice, AddOnPrice, AddOnMemberPrice, MaterialsCost, PrimaryVendor, Cost, Manufacturer, Priority.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string
Text to search for, 2 to 200 characters. Case-insensitive partial match on display name, code, and description.
string
Pricebook category ids to filter by. Returns items in these categories and all their subcategories; omit for all categories. The spec types this as one string and its example is 123,456.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return discounts and fees created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return discounts and fees modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data key to look up. external_data_values must also be given.
string
Return discounts and fees created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up. external_data_key must also be given. The spec types this as one string and does not document the separator.
string
Return discounts and fees modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PRICEBOOK_EQUIPMENTList equipment items in the ServiceTitan pricebook (sellable catalog entries such as furnaces), with optional search text and category filters. For equipment installed at a customer location use LIST_INSTALLED_EQUIPMENT. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the pricebook equipment items to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Code, DisplayName, CreatedOn, ModifiedOn, Price, MemberPrice, AddOnPrice, AddOnMemberPrice, MaterialsCost, PrimaryVendor, Cost, Manufacturer, Priority.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string
Text to search for, 2 to 200 characters. Case-insensitive partial match on display name, code, and description.
string
Pricebook category ids to filter by. Returns items in these categories and all their subcategories; omit for all categories. The spec types this as one string and its example is 123,456.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return pricebook equipment items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return pricebook equipment items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data key to look up. external_data_values must also be given.
string
Return pricebook equipment items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up. external_data_key must also be given. The spec types this as one string and does not document the separator.
string
Return pricebook equipment items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PRICEBOOK_MATERIAL_COST_TYPESList the cost types that can be assigned to materials in the ServiceTitan pricebook. Takes no inputs and returns a single page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PRICEBOOK_MATERIAL_MARKUPSList the material markup tiers in the ServiceTitan pricebook, each a from/to range with the markup percent applied to it. Returns one page per call; request the next page while has_more is true.

Input Parameters

integer
Page number to return, starting from 1.
integer
Number of records per page. The tool sends 50 when unset; the spec documents no default for this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PRICEBOOK_MATERIALSList materials in the ServiceTitan pricebook, with optional search text, category, and cost type filters. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the pricebook materials to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Code, DisplayName, CreatedOn, ModifiedOn, Price, MemberPrice, AddOnPrice, AddOnMemberPrice, MaterialsCost, PrimaryVendor, Cost, Manufacturer, Priority.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string
Text to search for, 2 to 200 characters. Case-insensitive partial match on display name, code, and description.
array
Ids of pricebook categories. Returns items in these categories and all their subcategories. Sent comma-separated, as the spec example shows. Omit to return items from all categories.
string
Ids of the cost types to filter by, as one string. The spec types this as a string and does not document the separator.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return pricebook materials created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return pricebook materials modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data key to filter by.
string
Return pricebook materials created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to filter by, as one string. The spec types this as a string and does not document the separator.
boolean
True returns only materials marked as other direct cost; false excludes them.
string
Return pricebook materials modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PRICEBOOK_SERVICESList services in the ServiceTitan pricebook, with optional search text and category filters. Set calculate_prices to apply current dynamic pricing rules. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the pricebook services to return. Maximum 50; sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Code, DisplayName, CreatedOn, ModifiedOn, Price, MemberPrice, AddOnPrice, AddOnMemberPrice, MaterialsCost, PrimaryVendor, Cost, Manufacturer, Priority.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string
Text to search for. Case-insensitive partial match on display name, code, and description.
string
Pricebook category ids. Returns items in these categories and all their subcategories. The spec types this as one string and does not document the separator.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return pricebook services created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return pricebook services modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to return prices calculated with the current dynamic pricing rules.
string
External data key to look up. external_data_values must also be given.
string
Return pricebook services created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up. external_data_key must also be given. The spec types this as one string and does not document the separator or a maximum.
string
Return pricebook services modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_BUDGET_CODESList the budget codes of one ServiceTitan project, one page per call, optionally filtered by budget code, segment or segment item IDs.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
ID of the project.
array
Return only budget codes that use these segments. List of ids, sent comma-separated.
boolean
Set true to have total_count filled in the response; otherwise it is null.
array
Return only budget codes with these IDs. List of ids, sent comma-separated.
array
Return only budget codes that use these segment items. List of ids, sent comma-separated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_BUDGET_CODE_SEGMENT_ITEM_CHILDRENList the child items under one item of a budget code segment within a ServiceTitan project, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
ID of the project.
integer
required
ID of the budget code segment.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
required
ID of the segment item.
boolean
Whether to include the child items nested under each segment item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_BUDGET_CODE_SEGMENT_ITEMSList the items of one budget code segment within a ServiceTitan project, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
ID of the project.
integer
required
ID of the budget code segment.
boolean
Set true to have total_count filled in the response; otherwise it is null.
boolean
Whether to include the child items nested under each segment item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_BUDGET_CODE_SEGMENTSList budget code segments of one ServiceTitan project’s work breakdown structure. Results can be requested by page; the response does not include a has_more flag.

Input Parameters

integer
Page number to return, starting from 1. Not sent unless set; the spec documents no default for this operation.
integer
Number of records per page. Not sent unless set; the spec documents no default and no maximum for this operation. The response has no has_more flag: the last page is the one with fewer records than page_size.
integer
required
ID of the project.
boolean
Documented query parameter of this operation. The documented response has no total count field, so its effect is not known.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_CUSTOM_FIELD_TYPESList the custom field types available for ServiceTitan projects, one page per call. Use the returned IDs as type_id in the custom_fields of Create Project or Update Project.

Input Parameters

string
Filters records by name (case-insensitive “contains” operation).
integer
Page number to return, starting at 1.
string
Field to sort by. Sortable fields: Id, Name. The spec of this operation does not state the +Field / -Field direction prefix that other ServiceTitan lists document.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_DAILY_LOGSList the daily logs of one ServiceTitan project, one page per call, optionally limited to a date range. Returns summaries; use Get Project Daily Log for the full log.

Input Parameters

integer
Page number to return, starting at 1.
string
Only return daily logs on or before this date, in yyyy-MM-dd format.
string
Only return daily logs on or after this date, in yyyy-MM-dd format.
integer
Number of records per page.
integer
required
The project ID.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_NOTESList the notes on one ServiceTitan project, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
ID of the project.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECTSList ServiceTitan projects, one page per call, filtered by customer, location, status, job, technician, manager or date ranges. Use job_id to find the project a job belongs to.

Input Parameters

array
Return only the records with these IDs. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn, Name, TargetCompletionDate.
integer
Return project if it contains the specified job.
string
Return projects that have one of the given statuses. Pass None as one of the values to include projects without a status. The separator for several values is not documented.
integer
Number of records per page.
integer
Return projects if it contains the specified invoice.
integer
Filters by customer ID.
integer
Filters by location ID.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return projects that start before date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Return project if technician is assigned to any appointments on any job in the project.
integer
Return project if it contains the specified appointment in the project’s jobs.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Filter by project number.
string
Return projects whose last modification date is before date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Return projects if it contains the specified project type.
string
Return projects that are completed before date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Returns projects which have at least one of the provided business units assigned. List of ids, sent comma-separated; the spec types this as one string and does not document the separator.
string
Performs lookup by external data key, external_data_values must also be provided.
string
Return projects that start on or after date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Filters by id of managers for matching project. List of ids, sent comma-separated; the spec types this as one string and does not document the separator.
string
External data values to look up, maximum 50. external_data_key must be sent with it. The spec types this as one string and does not document the separator.
string
Return projects whose last modification date is on or after date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return projects that are completed on or after date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return projects whose contract start date is before date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return projects whose target completion date is before date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
If this guid is provided, external data corresponding to this application guid will be returned. GUID string.
string
Return projects whose contract start date is on or after date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return projects whose target completion date is on or after date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_STATUSESList the project statuses configured in ServiceTitan, one page per call. Use the IDs as status_id on a project.

Input Parameters

array
Return only the records with these IDs. List of ids, max 50, sent comma-separated.
string
Filters by project status name.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name, Order, ModifiedOn, CreatedOn.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_SUB_STATUSESList the project sub statuses configured in ServiceTitan, one page per call, optionally for one parent status.

Input Parameters

array
Return only the records with these IDs. List of ids, max 50, sent comma-separated.
string
Filters by project sub status name.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name, Order, StatusId, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
integer
Filters by parent project status id.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROJECT_TYPESList the project types configured in ServiceTitan, one page per call. Use the IDs as project_type_id on a project.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROPOSAL_TEMPLATESList proposal templates in ServiceTitan, which map the options of a proposal type to estimate templates, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Filter by proposal type id, from the proposal types list.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROPOSAL_TYPESList proposal types in ServiceTitan with their options. Use it to get the proposal_type_id and proposal_type_option_id values that proposal templates need. Not paged.

Input Parameters

string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROVIDER_BOOKING_CONTACTSList the contact entries on one booking in ServiceTitan that belongs to a given booking provider, one page per call. Works only when the connection was granted the booking provider tag passed as booking_provider_id. Use LIST_BOOKING_CONTACTS when the connection has no booking provider restriction.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
integer
required
Id of the booking.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
required
Id of the booking provider tag this connection was granted, from LIST_BOOKING_PROVIDER_TAGS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PROVIDER_BOOKINGSList the bookings in ServiceTitan that belong to one booking provider, one page per call. Works only when the connection was granted the booking provider tag passed as booking_provider_id.

Input Parameters

array
Return only the records with these ids. Maximum 50; sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
integer
Number of records per page.
string
Filters by booking’s external ID.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
Id of the booking provider tag this connection was granted, from LIST_BOOKING_PROVIDER_TAGS.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PURCHASE_ORDER_MARKUPSList the purchase order markup tiers in ServiceTitan, each a from/to range with the markup percent applied to it. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the purchase order markups to return, sent comma-separated. The spec documents no maximum for this operation.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, From, To, Percent.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return purchase order markups created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase order markups modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase order markups created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase order markups modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PURCHASE_ORDER_REQUESTSList purchase order requests in ServiceTitan, filtered by request status, number, job, project, technician, or date range. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the purchase order requests to return, sent comma-separated. The spec documents no maximum for this operation.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
integer
Id of the job to filter by.
string
Ids of the jobs to filter by. The spec types this as one string and does not document the separator.
integer
Number of records per page.
integer
Id of the project to filter by.
string
Return purchase order requests with date before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Id of the technician to filter by.
string
Return purchase order requests created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Purchase order request number to filter by.
string ("PendingApproval" | "Approved" | "Rejected")
Purchase order request status to filter by. The spec enum has PendingApproval, Approved and Rejected; its text names only PendingApproval and Rejected as available.
string
Return purchase order requests modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase order requests with date on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase order requests created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase order requests modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PURCHASE_ORDERSList purchase orders in ServiceTitan, filtered by status, number, job, project, technician, inventory location, or date range. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the purchase orders to return. Maximum 50; sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn, Date, RequiredOn.
integer
Id of the job to filter by.
string
Return the purchase orders with this number.
string ("Pending" | "Sent" | "PartiallyReceived" | "Received" | "Exported" | "Canceled")
Purchase order status to filter by: Pending, Sent, PartiallyReceived, Received, Exported or Canceled.
string
Ids of the jobs to filter by. The spec types this as one string and does not document the separator.
integer
Number of records per page.
integer
Id of the project to filter by.
string
Return purchase orders with date before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase orders sent before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Id of the technician to filter by.
string
Return purchase orders created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase orders modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase orders with required on date before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase orders with date on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase orders sent on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase orders created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase orders modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase orders with required on date on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Ids of the inventory locations to filter by. The spec types this as one string and does not document the separator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_PURCHASE_ORDER_TYPESList purchase order types in ServiceTitan; a type id is required to create a purchase order. Returns one page per call; request the next page while has_more is true.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return purchase order types created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase order types modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase order types created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return purchase order types modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_RECURRING_SERVICE_EVENTSList recurring service events in ServiceTitan, the visits generated from a location’s recurring services, filtered by location, job, follow-up status or created/modified time.

Input Parameters

array
Ids of the events to look up. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The sortable fields are not documented for this operation.
integer
Filter by job id.
string ("NotAttempted" | "Unreachable" | "Contacted" | "Won" | "Dismissed")
Filter by follow-up status of the event: NotAttempted, Unreachable, Contacted, Won or Dismissed.
integer
Number of records per page.
integer
Filter by location id.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_RECURRING_SERVICESList location recurring services in ServiceTitan (a recurring service type applied to one location), filtered by membership, location or created/modified time. Technician ids are left out unless include_technicians is true.

Input Parameters

array
Ids of the recurring services to look up. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The sortable fields are not documented for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string
Location ids to filter by, as one string. The spec types this as a string and does not document the separator.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Customer membership ids to filter by, as one string. The spec types this as a string and does not document the separator.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to include preferred technician ids in the result; otherwise preferred_technician_ids is null.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_RECURRING_SERVICE_TYPESList recurring service types in ServiceTitan, the templates that location recurring services are created from, filtered by membership type, recurrence type or duration type.

Input Parameters

array
List of ids to look up, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string ("Continuous" | "NumberOfVisits")
Filters by duration type.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("Weekly" | "Monthly" | "Seasonal" | "Daily" | "NthWeekdayOfMonth")
Filters by recurrence type.
integer
Filters by membership type ID.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_REMITTANCE_VENDORSList remittance vendors (the pay-to parties for vendor payments) in ServiceTitan, one page per call. These are not the inventory vendors that purchase orders are placed with.

Input Parameters

array
Return only the remittance vendors with these ids. The spec types this parameter as an array, so each id is sent as its own ids value; it documents no maximum.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_REPORT_CATEGORIESList the report categories in ServiceTitan. Start here: every other report tool needs a category id.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_REPORTSList the reports in one report category in ServiceTitan, with id, name and description.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
required
Id of the report category, from the report categories list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_REVIEWSList customer reviews collected by ServiceTitan Marketing Reputation, one page per call, filtered by date, rating, source, technician, campaign or location. Several filters take numeric codes whose meanings the spec does not document.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. The sortable fields are not documented for this operation.
array
Return only reviews from these sources (review platforms). The accepted names are not documented.
string
End of the review date range. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Start of the review date range. The spec does not say which review date this filters. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Number of records per page.
number
Highest rating to include.
string
Return the review with this external id, the id given by the review platform.
number
Lowest rating to include.
integer
Return the review with this internal id.
integer ("0" | "1" | "2")
Report type code: 0, 1 or 2. The spec does not document what each code means.
string
Free-text search term. The spec does not say which review fields are searched.
array
Return only reviews matched to these campaign ids.
array
Return only reviews matched to these location ids.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Response type codes to include, each 0, 1 or 2. The spec does not document what each code means.
array
Return only reviews matched to these technician ids.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Review match status codes to include, each 0 to 6. The spec does not document what each code means.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to also return reviews not matched to any campaign.
boolean
Set true to also return reviews not matched to any location.
boolean
Set true to also return reviews not matched to any technician.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_ROUTER_SESSIONSList the customer booking sessions that went through one Scheduling Pro router in ServiceTitan, with outcome, customer details and any job or booking created.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
string
required
Id of the Scheduling Pro router (a string). No ServiceTitan API lists routers, so the id has to come from the user.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_SCHEDULERSList the online booking schedulers set up in ServiceTitan Scheduling Pro, with their status and default flag. Each record also carries data_api_key, the scheduler’s web-install key; it is sensitive, so do not repeat it to the user unless asked.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_SCHEDULER_SESSIONSList the customer booking sessions of one Scheduling Pro scheduler in ServiceTitan, with customer details, outcome and any job or booking created.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of records per page.
string
required
Id of the Scheduling Pro scheduler (a string), from the schedulers list.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_SERVICE_AGREEMENT_CUSTOM_FIELD_TYPESList the custom field types defined for service agreements in ServiceTitan. Returns field definitions, not the values stored on an agreement.

Input Parameters

string
Filter by name; case-insensitive ‘contains’ match.
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The sortable fields are not documented for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_SERVICE_AGREEMENTSList service agreements in ServiceTitan, the maintenance contracts for commercial customers, filtered by customer, business unit, status or created/modified time. Read-only: the API has no way to create or change an agreement.

Input Parameters

array
Return only the agreements with these ids. Maximum 50; sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name, CreatedOn, ModifiedOn, StartDate, EndDate.
string ("Draft" | "Sent" | "Rejected" | "Accepted" | "Activated" | "Canceled" | "Expired" | "AutoRenew")
Filter by service agreement status.
integer
Number of records per page.
string
Filter by customer ids. The spec types this as one string and does not document how several ids are separated.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Filter by business unit ids. The spec types this as one string and does not document how several ids are separated.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TAG_TYPESList tag types in ServiceTitan, the labels that can be put on customers, jobs, locations and other records. The tag type ids are what other tools take as tag_type_ids.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TASKSList office tasks in ServiceTitan Task Management, one page per call, filtered by status, priority, assignee, customer, job, project or dates. Set include_subtasks to true to also return each task’s subtasks. These are Task Management tasks, not the invoice workflow tasks of CREATE_INVOICE_TASK / LIST_INVOICE_TASKS.

Input Parameters

array
List of task ids to look up, sent comma-separated.
string
Filter by task name.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, DescriptionModifiedOn, CompletedBy, Priority.
string ("True" | "Any" | "False")
Filter by active status: True (active only), False (inactive only), Any (both). The spec does not document the default for this operation.
integer
Filter by job id.
string
Task status to filter by. Documented status values: ToDo, InProgress, OnHold, Canceled, Completed. The spec types this as one string and does not document the format for several statuses.
boolean
Deprecated, use statuses. Filter by whether the task is closed.
integer
Number of records per page.
string
Filter by job number (the human-readable number, not the job id).
array
Task priorities to include, sent comma-separated. Values: Low, Normal, High, Urgent.
integer
Filter by project id.
integer
Filter by customer id.
integer
Filter by task number (the human-readable number, not the task id).
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Filter by the id of the employee the task is assigned to.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Filter by the id of the employee who reported the task.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return tasks reported before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return tasks completed before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Set true to include each task’s subtasks in sub_tasks_data. The spec does not document the default.
array
List of business unit ids to filter by, sent comma-separated.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return tasks reported on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return tasks completed on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
List of employee ids involved in the task, sent comma-separated.
array
List of task type ids to filter by, sent comma-separated.
array
List of task source ids to filter by, sent comma-separated.
string
Return tasks whose description was modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
List of task resolution ids to filter by, sent comma-separated.
string
Return tasks whose description was modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TAX_ZONESList tax zones and their tax rates in ServiceTitan, one page per call. With no active-status filter, the default is active tax zones.

Input Parameters

array
Return only the tax zones with these ids; sent comma-separated. The spec types this parameter as one string and documents neither the separator nor a maximum.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, Name, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return tax zones created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return tax zones modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return tax zones created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return tax zones modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TEAMSList ServiceTitan dispatch teams, one page per call. Inactive teams are left out unless include_inactive is true.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, ModifiedOn.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Whether to include inactive teams. This operation uses include_inactive instead of the active filter.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TECHNICIAN_PAYROLLSList the payrolls (pay period records) of one technician in ServiceTitan, one page per call. Use LIST_EMPLOYEE_PAYROLLS for an office employee.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. The spec does not list the sortable fields for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string ("Pending" | "Expired" | "Approved" | "Paid" | "Locked")
Return only payrolls with this status.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
required
Id of the technician.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payrolls whose period ends on or before this time. The spec text says ‘before’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payrolls whose period starts on or after this time. The spec text says ‘after’, so whether the boundary itself is included is unverified. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return payrolls approved on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TECHNICIAN_RATINGSList technician ratings in ServiceTitan, one page per call, filtered by technician, job or dates. Each rating is tied to one technician and one job.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. The sortable fields are not documented for this operation.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Return only ratings tied to this job id.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Return only ratings of this technician id.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TECHNICIANSList technicians in ServiceTitan, the field staff who work jobs, filtered by name or user id. Office employees are a separate resource.

Input Parameters

array
Return only the technicians with these ids. Maximum 50; sent comma-separated.
string
Filter by name; case-insensitive ‘contains’ match.
integer
Page number to return, starting at 1.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
string
Return only the technicians with these user ids, maximum 50. The spec types this as one string and does not document the separator.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TECHNICIAN_SHIFTSList ServiceTitan technician shifts, one page per call, filtered by technician, shift type (Normal, OnCall, TimeOff), time range, or text in the title or note.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string ("Normal" | "OnCall" | "TimeOff")
Return shifts of this type.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return shifts whose note contains this text.
integer
Return shifts of this technician.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return shifts whose title contains this text.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return shifts that end on or before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return shifts that start on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TECHNICIAN_SKILLSList ServiceTitan technician skills, one page per call, optionally for one technician. Each entry is one skill held by one technician.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
integer
Return only the skills of this technician.
string
Return items created before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after certain date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TIMESHEET_ACTIVITIESList timesheet activities (blocks of time recorded against an activity type, from the Timesheets API) in ServiceTitan, one page per call. It filters only by job, project, active status and created or modified dates, not by employee or work date; for job dispatch/arrive/done times use LIST_PAYROLL_JOB_TIMESHEETS, for time booked to payroll timesheet codes use LIST_NON_JOB_TIMESHEETS, and for paid earnings use LIST_GROSS_PAY_ITEMS.

Input Parameters

integer
Page number to return, starting at 1.
string
Sort order. The spec says only that this applies sorting by the specified fields; it lists no sortable fields and no format for this operation. Other ServiceTitan lists use +Field ascending and -Field descending.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Return only activities associated with the job with this id.
integer
Number of records per page.
integer
Return only activities associated with the project with this id.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TIMESHEET_ACTIVITY_CATEGORIESList timesheet activity categories, the groups that activity types belong to, in ServiceTitan, one page per call.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TIMESHEET_ACTIVITY_TYPESList timesheet activity types in ServiceTitan, one page per call. Use it to find the activity_type_id needed to create a timesheet activity.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this date-time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TIMESHEET_CODESList timesheet codes in ServiceTitan, one page per call. Each code says which employee type it applies to and whether it is unpaid, paid, clock in/out or paid time off. Codes are the categories used by LIST_NON_JOB_TIMESHEETS; they are not payroll activity codes (LIST_PAYROLL_ACTIVITY_CODES).

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_TRUCKSList trucks in ServiceTitan inventory, the vehicle inventory locations assigned to technicians. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the trucks to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return trucks created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return trucks modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data key to look up. external_data_values must also be given.
string
Return trucks created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up, maximum 50. external_data_key must also be given. The spec types this as one plain string and the format for several values is undocumented.
string
Return trucks modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_USER_ROLESList user roles in ServiceTitan, the permission sets assigned to employees and technicians. Use it to get the role_id needed to create an employee or technician.

Input Parameters

array
Return only the user roles with these ids. Maximum 50; sent comma-separated.
string
Filter by name; case-insensitive ‘contains’ match.
integer
Page number to return, starting at 1.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
string ("None" | "Employee" | "Technician" | "All")
Filter roles by employee type: None, Employee, Technician or All.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_VEHICLE_EVENTSList historical driving events for FleetPro vehicles in ServiceTitan, by VIN and time window. Only data older than 7 days is available, the window may span at most 24 hours, at most 50 VINs per call, and results are capped at 10,000 records.

Input Parameters

array
required
Vehicle Identification Numbers to return data for, 1 to 50. Get them from the vehicles list.
string
required
End of the time window, at most 24 hours after start_time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
object
required
Paging settings, sent in the request body. Required: set pageNumber (starting at 1) and pageSize; to read the next page, call again with pageNumber plus 1.
string
required
Start of the time window. Must be more than 7 days in the past. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_VEHICLE_GPS_RECORDSList historical GPS positions for FleetPro vehicles in ServiceTitan, by VIN and time window. Only data older than 7 days is available, the window may span at most 24 hours, at most 50 VINs per call, and results are capped at 10,000 records.

Input Parameters

array
required
Vehicle Identification Numbers to return data for, 1 to 50. Get them from the vehicles list.
string
required
End of the time window, at most 24 hours after start_time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
object
required
Paging settings, sent in the request body. Required: set pageNumber (starting at 1) and pageSize; to read the next page, call again with pageNumber plus 1.
string
required
Start of the time window. Must be more than 7 days in the past. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_VEHICLESList every FleetPro vehicle in ServiceTitan with its VIN, name and driver. Use it to get the VINs that the vehicle GPS and event tools filter by. Not paged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_VENDOR_CUSTOM_FIELD_TYPESList the custom field types defined for ServiceTitan vendors, with each type’s data type and options. Use it to find valid custom field names before writing vendor custom fields. Returns one page per call; request the next page while has_more is true.

Input Parameters

string
Return vendor custom field types whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
Sort order: +Field ascending, -Field descending. The spec does not list the sortable fields for this operation.
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return vendor custom field types created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return vendor custom field types modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return vendor custom field types created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return vendor custom field types modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_VENDORSList inventory vendors (suppliers) in ServiceTitan, filtered by name, ids, active status, external data, or date range. Returns one page per call; request the next page while has_more is true. For the pay-to parties of vendor payments use LIST_REMITTANCE_VENDORS.

Input Parameters

array
Return only the vendors with these ids. The spec types this parameter as an array, so each id is sent as its own ids value; it documents no maximum.
string
Return vendors whose name contains this text (case-insensitive).
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
object
Custom field name-value filters. Each entry is sent as customField.name=value.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return vendors created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return vendors modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data key to look up. external_data_values must also be given.
string
Return vendors created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up, maximum 50. external_data_key must also be given. The spec types this as one plain string and the format for several values is undocumented.
string
Return vendors modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("And" | "Or")
Operator between custom field filters: And or Or.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_WAREHOUSESList warehouses in ServiceTitan inventory; warehouse ids are used as inventory locations on purchase orders, returns, and trucks. Returns one page per call; request the next page while has_more is true.

Input Parameters

array
Ids of the warehouses to return. List of ids, max 50, sent comma-separated.
integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, ModifiedOn, CreatedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return warehouses created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return warehouses modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data key to look up. external_data_values must also be given.
string
Return warehouses created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
External data values to look up, maximum 50. external_data_key must also be given. The spec types this as one plain string and the format for several values is undocumented.
string
Return warehouses modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Application GUID whose external data should be returned with each record. External data written under one GUID is only visible with that same GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LIST_ZONESList ServiceTitan dispatch zones, one page per call. A zone groups zip codes, cities or territories and the business units and technicians that serve them.

Input Parameters

integer
Page number to return, starting at 1.
string
+Field ascending, -Field descending. Sortable fields: Id, CreatedOn, ModifiedOn.
string ("True" | "Any" | "False")
Filter by active status: True (active only, default), False (inactive only), Any (both).
integer
Number of records per page.
boolean
Set true to have total_count filled in the response; otherwise it is null.
string
Return items created before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified before this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items created on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Return items modified on or after this time. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_LOOKUP_OPT_OUTSCheck the opt-out status of specific phone numbers in ServiceTitan. Numbers with no opt-out are left out of the result, and the whole request fails if any number cannot be parsed.

Input Parameters

array
required
Phone numbers to act on; at least one. Each must be a valid phone number, E.164 format such as +15551234567 recommended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_AP_BILLS_AS_EXPORTEDMark one or more AP bills as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.

Input Parameters

array
required
List of AP bill IDs to mark as exported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_AP_CREDITS_AS_EXPORTEDMark one or more AP credits as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.

Input Parameters

array
required
The AP credits to mark as exported, one entry per AP credit, each with its id. At least one AP credit is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_AP_PAYMENTS_AS_EXPORTEDMark one or more AP payments as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.

Input Parameters

array
required
The AP payments to mark as exported, one entry per AP payment, each with its id and optional external id and message. At least one AP payment is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_BANK_DEPOSITS_AS_EXPORTEDMark one or more bank deposits as exported to an external accounting system in ServiceTitan. Unlike the other mark-as-exported tools, the documented response has no body, so there is no per-id result to check. ServiceTitan documents no operation to undo the exported mark.

Input Parameters

array
required
List of bank deposit ids to mark as exported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_CREDIT_MEMOS_AS_EXPORTEDMark one or more credit memos as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.

Input Parameters

array
required
The credit memos to mark as exported, one entry per credit memo, each with its id and optional external id and message. At least one credit memo is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_EXPENSE_TRANSACTIONS_AS_EXPORTEDMark one or more expense transactions as exported in ServiceTitan. Only an expense in the Posted state moves to Exported; an id that is missing or not Posted comes back as a failure row while the call itself still succeeds. ServiceTitan documents no operation to undo a successful exported mark.

Input Parameters

array
required
List of expense transaction IDs to mark as exported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_INVENTORY_BILLS_AS_EXPORTEDMark one or more inventory bills as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. ServiceTitan documents no operation to undo a successful exported mark.

Input Parameters

array
required
List of inventory bill ids to mark as exported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_INVOICES_AS_EXPORTEDMark one or more invoices as exported to an external accounting system in ServiceTitan. Returns one result row per id with a success flag and error message, so check each row: a failed id does not fail the call. No operation to undo the mark is documented.

Input Parameters

array
required
The invoices to mark as exported, one entry per invoice, each with its id and optional external id and message. At least one invoice is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_RECURRING_SERVICE_EVENT_COMPLETEMark a recurring service event complete in ServiceTitan by linking it to a job. It also copies the recurring service’s invoice template items onto that job’s invoice.

Input Parameters

integer
required
Id of the job the event is completed on; the event is linked to this job.
integer
required
Id of the recurring service event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MARK_RECURRING_SERVICE_EVENT_INCOMPLETEMark a recurring service event incomplete in ServiceTitan by unlinking it from a job. It also deletes the invoice items that were copied onto the job’s invoice when the event was completed.

Input Parameters

integer
required
Id of the job the event was completed on; the event is unlinked from this job.
integer
required
Id of the recurring service event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MATCH_BUDGET_CODESCheck budget code strings against the company-level ServiceTitan budget codes; each input code comes back with a validity flag and the budget codes it matches. Read-only.

Input Parameters

array
required
Budget code strings to check. Sent as a repeated query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_MATCH_PROJECT_BUDGET_CODESCheck budget code strings against the budget codes of one ServiceTitan project; each input code comes back with a validity flag and the budget codes it matches. Read-only.

Input Parameters

array
required
Budget code strings to check. Sent as a repeated query parameter.
integer
required
ID of the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REJECT_PURCHASE_ORDER_REQUESTReject a ServiceTitan purchase order request by its request id, with a required rejection reason. Takes the request id from LIST_PURCHASE_ORDER_REQUESTS, not a purchase order id. No way to withdraw a rejection is documented.

Input Parameters

string ("CostTooHigh" | "WrongVendor" | "Other")
required
Reason the purchase order request is rejected.
integer
required
Id of the purchase order request to reject; this is not a purchase order id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REMOVE_APPOINTMENT_CONFIRMATIONRemove the confirmation from a ServiceTitan job appointment, returning it to unconfirmed.

Input Parameters

integer
required
ID of the job appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REMOVE_APPOINTMENT_HOLDRemove the hold from a ServiceTitan job appointment that was put on hold.

Input Parameters

integer
required
ID of the job appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REMOVE_CUSTOMER_TAGRemove one tag type from one customer in ServiceTitan. The tag type itself is kept. Use REMOVE_TAGS_FROM_CUSTOMERS for several customers or tags at once.

Input Parameters

integer
required
Id of the customer.
integer
required
Id of the tag type, as defined in the Settings tag types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REMOVE_EQUIPMENT_FROM_EQUIPMENT_SYSTEMDetach installed equipment from a ServiceTitan equipment system, by system id and a list of installed equipment ids. The equipment records themselves are not deleted.

Input Parameters

array
required
Installed equipment IDs to remove from the system. Only direct children (direct_child_equipment_ids) can be removed this way.
integer
required
Id of the equipment system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REMOVE_JOB_CANCELLATIONUndo the cancellation of a ServiceTitan job that was canceled.

Input Parameters

integer
required
ID of the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REMOVE_LOCATION_TAGRemove one tag type from one location in ServiceTitan. The tag type itself is kept.

Input Parameters

integer
required
Id of the location.
integer
required
Id of the tag type, as defined in the Settings tag types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REMOVE_TAGS_FROM_CUSTOMERSRemove one or more tag types from several customers in ServiceTitan in one call. Every tag type listed is removed from every customer listed. Use REMOVE_CUSTOMER_TAG for a single customer and tag.

Input Parameters

array
required
Ids of the customers to remove tags from.
array
required
Ids of the tag types to remove from every customer listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REPLACE_CONTACTReplace a contact in ServiceTitan with the values sent. is_archived is required, and name, title or reference_id left out are cleared; use UPDATE_CONTACT to change only some fields.

Input Parameters

string
Name of the contact.
string
Title of the contact.
string
required
GUID of the contact, from LIST_CONTACTS.
boolean
required
Whether the contact is archived.
string
External reference ID of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REPLACE_CONTACT_METHODReplace a contact method of a contact in ServiceTitan with the values sent. type and value are required, and optional fields left out are cleared; use UPDATE_CONTACT_METHOD to change only some fields.

Input Parameters

string
Short note about this contact method, for example ‘work number’.
string ("Phone" | "Email" | "Fax" | "MobilePhone")
required
Type of the contact method.
string
required
The phone number, email address or fax number.
string
required
GUID of the contact, from LIST_CONTACTS.
string
Reference ID of the contact method.
string
required
GUID of the contact method, from LIST_CONTACT_METHODS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_REPLACE_JOURNAL_ENTRYReplace an external journal entry in ServiceTitan, including all of its lines. Only entries created through the API (external) can be replaced, and lines are overwritten: send every line to keep, because any line left out is deleted.

Input Parameters

string
Name of the journal entry.
array
The complete set of lines to keep; each needs debit and credit. Lines left out are deleted.
string ("Open" | "Closed")
required
Posting status of the journal entry: Open or Closed.
string
Message stored with the journal entry.
string
Posting date. Date in YYYY-MM-DD form, e.g. 2025-01-31.
integer
required
Version number of the journal entry being replaced.
object
Custom fields as name-value pairs of strings.
string
required
Id of the journal entry (a GUID string), from LIST_JOURNAL_ENTRIES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_RESCHEDULE_APPOINTMENTMove a ServiceTitan job appointment to a new start and end time, and optionally a new arrival window. It changes only the schedule, not the assigned technicians.

Input Parameters

string
New end date-time for appointment. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
New start date-time for appointment. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
ID of the job appointment.
string
New arrival window end date-time for appointment, if configured. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
New arrival window start date-time for appointment, if configured. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_SELL_ESTIMATEMark an estimate as sold in ServiceTitan and credit the sale to a technician. sold_by_id must be a managed technician, and an estimate sold this way is set to ‘perform work later’, so the job still has to be booked.

Input Parameters

integer
required
Id of the technician credited with the sale. Must be a managed technician.
integer
required
Id of the estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_SEND_EMPLOYEE_ACCOUNT_INVITESend an account invitation to a ServiceTitan employee. The sent invitation cannot be recalled.

Input Parameters

integer
required
Id of the employee who should receive an account invitation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_SEND_TECHNICIAN_ACCOUNT_INVITESend an account invitation to a ServiceTitan technician. The sent invitation cannot be recalled.

Input Parameters

integer
required
Id of the technician who should receive an account invitation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_SET_APPOINTMENT_SUMMARYSet the work-performed summary for one technician on a ServiceTitan job appointment. Private preview: available to specific accounts only, so expect an error on tenants without it.

Input Parameters

string
required
Work performed notes.
integer
required
ID of the technician.
integer
required
ID of the job appointment.
string
The modifiedOn value you last read for this summary. If the record changed after it, the update is skipped so a newer value is not overwritten. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_SET_ARRIVAL_WINDOW_ACTIVEActivate or deactivate a ServiceTitan arrival window by setting its active flag.

Input Parameters

boolean
required
True activates the arrival window; False deactivates it.
integer
required
ID of the arrival window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_SET_BUSINESS_UNIT_EXTERNAL_DATAAttach external data (key/value pairs owned by an application GUID) to a business unit in ServiceTitan. It cannot change the unit’s name, address or other settings.

Input Parameters

object
External data to attach to the business unit. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
integer
required
Id of the business unit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_START_REPORT_DATA_QUERYStart a long-running report data query in ServiceTitan. If it finishes within about 10 seconds the rows come back directly; otherwise it returns a status and a query_token to poll for the result. Rate limit: 1 call of the same report per minute per tenant. Use GET_REPORT_DATA for fast reports that return within one call.

Input Parameters

integer
Page number to return, starting at 1.
integer
Number of rows per page, 1 to 25000. Default 1000.
integer
required
Id of the report within the category, from the reports list.
array
required
Input parameters of the report as name/value pairs. Get the names, data types and required flags from the report definition.
string
required
Id of the report category, from the report categories list.
boolean
Set true to fire a tn.rpr.report-data-ready webhook when a query that did not finish inline later completes or errors. Default false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_SUBMIT_LEAD_FORMSubmit a lead form to ServiceTitan with a person’s name and optional email, phone, address and summary, creating a lead and returning its id. Use CREATE_LEAD when you already have a campaign id and want to set lead fields directly.

Input Parameters

string
required
The name of the customer.
string
The email of the customer.
object
The address of the customer. When sent, street, city, state, zip and country are required.
string
Summary submitted in the form.
string
The phone number of the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UNASSIGN_TECHNICIANS_FROM_APPOINTMENTRemove one or more technicians from a ServiceTitan job appointment. Returns the appointment.

Input Parameters

integer
required
ID of the job appointment to unassign technicians from.
array
required
IDs of the technicians to unassign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UNSELL_ESTIMATERevert a sold estimate to unsold in ServiceTitan. It only works when no signature has been collected and the estimate has not been booked out into a job.

Input Parameters

integer
required
Id of the estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_AP_BILL_CUSTOM_FIELDSSet custom field values on one or more AP bills in ServiceTitan. Each operation names one AP bill id and the fields to set; a field name must already exist as a custom field type, and the documented response has no body.

Input Parameters

array
required
Custom field updates to apply, one entry per AP bill.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_AP_CREDIT_CUSTOM_FIELDSSet custom field values on one or more AP credits in ServiceTitan. Each operation names one AP credit id and the fields to set; a field name must already exist as a custom field type, and the documented response has no body.

Input Parameters

array
required
Custom field updates to apply, one entry per AP credit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_AP_PAYMENT_CUSTOM_FIELDSSet custom field values on one or more AP payments in ServiceTitan. Each operation names one AP payment id and the fields to set; a field name must already exist as a custom field type, and the documented response has no body.

Input Parameters

array
required
Custom field updates to apply, one entry per AP payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_APPOINTMENT_SPECIAL_INSTRUCTIONSReplace the special instructions text on a ServiceTitan job appointment. The new text overwrites the existing instructions.

Input Parameters

integer
required
ID of the job appointment.
string
required
New special instructions associated to the appointment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_ARRIVAL_WINDOWReplace the start time, duration and business units of a ServiceTitan arrival window. All three fields are required. To turn a window on or off use Set Arrival Window Active.

Input Parameters

string
required
Start time of the arrival window as a TimeSpan string, e.g. 09:00.
string
required
Documented as the end time for the arrival window defined as TimeSpan, e.g. 11:00, although the field is named duration. Which of the two the API expects is unverified.
integer
required
ID of the arrival window.
array
required
IDs of the business units this arrival window applies to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_ARRIVAL_WINDOW_CONFIGURATIONChange the tenant-wide ServiceTitan arrival window setting that decides whether a job’s default start time is the start or the end of the chosen arrival window. Affects all future bookings.

Input Parameters

string ("StartTimeOfArrivalWindow" | "EndTimeOfArrivalWindow")
required
Which end of the arrival window becomes the job’s default start time when booking or rescheduling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_BOOKINGUpdate fields of an existing booking in ServiceTitan for a given booking provider. Only the fields sent are changed; if address is sent, all six of its fields are required.

Input Parameters

string
Name of the booking’s customer.
string
Requested start time of the booking. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Source of the booking.
object
New address of the booking. When sent, street, unit, city, state, zip and country are all required.
string
Booking summary.
string ("Low" | "Normal" | "High" | "Urgent")
Booking priority.
integer
required
Id of the booking.
integer
ID of the booking’s campaign.
string
External ID of booking.
integer
ID of the booking’s job type.
string ("Residential" | "Commercial")
Type of customer.
array
Images attached to the booking, as a list of strings. The spec does not say whether these are URLs or file names.
integer
ID of the booking’s business unit.
integer
required
Id of the booking provider tag this connection was granted, from LIST_BOOKING_PROVIDER_TAGS.
boolean
Whether this is a first-time client.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_BOOKING_CONTACTUpdate one contact entry on a booking in ServiceTitan for a given booking provider. Only the fields sent are changed.

Input Parameters

string
Short note about this contact entry.
string ("Phone" | "Email" | "Fax" | "MobilePhone")
Type of contact entry.
string
The phone number, email address or fax number.
integer
required
Id of the booking.
integer
required
Id of the contact entry, from the matching contacts list tool. This is a numeric id, not a contact GUID.
integer
required
Id of the booking provider tag this connection was granted, from LIST_BOOKING_PROVIDER_TAGS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_BOOKING_PROVIDER_TAGUpdate the name or description of a booking provider tag in ServiceTitan. Only the fields sent are changed.

Input Parameters

string
Name of the booking provider tag.
string
Description of the booking provider tag.
integer
required
Id of the booking provider tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CALLUpdate a call record in ServiceTitan: its call type, reason, excuse memo, tag and linked customer, location, job, campaign or agent. This is a PUT and excuse_memo, reason, customer, location and tag are required on every call; GET_CALL does not return the current location, excuse memo or tag, so have those values ready before calling.

Input Parameters

string
required
Tag on the call. Required; send an empty string when there is none.
integer
Id of the job booked from the call.
object
required
Reason recorded for the call outcome: name and lead are required.
integer
required
Id of the call.
integer
Id of the agent (employee) who handled the call.
object
required
The customer linked to the call: id, name, address and contacts are required.
object
required
The service location linked to the call: id, name, address and contacts are required.
string ("Abandoned" | "Unbooked" | "Excused" | "Booked" | "NotLead")
Call classification: Abandoned, Unbooked, Excused, Booked or NotLead.
integer
Id of the marketing campaign the call is attributed to.
string
required
Memo explaining why the call was excused or not booked. Required; send an empty string when there is none.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CAMPAIGNUpdate a marketing campaign in ServiceTitan. The spec requires name, business_unit_id, category_id and active on every call, so read the campaign first and send its current values for fields you are not changing.

Input Parameters

string
Tracking phone number (DNIS) of the campaign. Calls to this number are attributed to the campaign.
string
required
Name of the campaign.
boolean
required
Whether the campaign is active.
string
Marketing medium of the campaign. Accepted values are not documented.
string
Traffic source of the campaign. Accepted values are not documented.
integer
required
Id of the marketing campaign.
integer
required
Id of the campaign category, from LIST_CAMPAIGN_CATEGORIES.
string
Free-text medium label. How it relates to medium is not documented.
string
Free-text source label. How it relates to source is not documented.
integer
required
Id of the business unit the campaign belongs to.
boolean
Set true to make this the default campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CAMPAIGN_CATEGORYRename a marketing campaign category in ServiceTitan or change its active flag. name is required on every call, even when only active changes.

Input Parameters

string
required
Name of the campaign category. Required even when only active changes.
boolean
Whether the category is active.
integer
required
Id of the campaign category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CAMPAIGN_COSTChange the daily cost of an existing campaign cost record in ServiceTitan. The campaign, year and month of the record cannot be changed.

Input Parameters

number
required
New cost per day for the record’s month, as a decimal amount.
integer
required
Id of the campaign cost record, from LIST_CAMPAIGN_COSTS. This is not the campaign id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CLIENT_SPECIFIC_PRICING_RATE_SHEETUpdate the per-SKU price exceptions of a client-specific pricing rate sheet in the ServiceTitan pricebook, by rate sheet id. The spec does not say whether the exceptions sent replace the sheet’s current list or are merged into it.

Input Parameters

array
Per-SKU price exceptions for the rate sheet, each with skuId, value and valueType.
integer
required
Id of the rate sheet to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CONTACTUpdate a contact’s name, title, reference id or archived flag in ServiceTitan. The spec lists is_archived as required even though this is a partial update. Use REPLACE_CONTACT to overwrite every field.

Input Parameters

string
Name of the contact.
string
Title of the contact.
string
required
GUID of the contact, from LIST_CONTACTS.
boolean
required
Whether the contact is archived.
string
External reference ID of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CONTACT_METHODUpdate the value or memo of a contact method in ServiceTitan. Only the fields sent are changed; the type cannot be changed here. Use REPLACE_CONTACT_METHOD to overwrite every field, including type. contact_id is the GUID of a person contact from CREATE_CONTACT or LIST_CONTACTS; to add a phone or email directly to a customer, location or booking use CREATE_CUSTOMER_CONTACT, CREATE_LOCATION_CONTACT or CREATE_BOOKING_CONTACT.

Input Parameters

string
Short note about this contact method, for example ‘work number’.
string
The phone number, email address or fax number.
string
required
GUID of the contact, from LIST_CONTACTS.
string
required
GUID of the contact method, from LIST_CONTACT_METHODS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CONTACT_METHOD_PREFERENCESet the value of one communication preference on a contact method in ServiceTitan. The value is sent as a string whatever the preference’s data type.

Input Parameters

string
required
New value of the preference, sent as a string (for a boolean preference, ‘true’ or ‘false’).
string
required
GUID of the contact, from LIST_CONTACTS.
string
required
Name of the preference, from LIST_CONTACT_PREFERENCE_TYPES.
string
required
GUID of the contact method, from LIST_CONTACT_METHODS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CREDIT_MEMOUpdate a credit memo’s summary, date, business unit or active flag in ServiceTitan; only the fields sent are changed. It cannot change amounts or applications: use ADD_CREDIT_MEMO_SPLITS to apply the memo to invoices.

Input Parameters

string
Date of the credit memo. Date in YYYY-MM-DD form, e.g. 2025-01-31.
boolean
Whether the credit memo is active; false deactivates it.
string
Summary text of the credit memo.
integer
required
Id of the credit memo.
integer
Id of the business unit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CREDIT_MEMO_CUSTOM_FIELDSSet custom field values on one or more credit memos in ServiceTitan. Each operation names one credit memo id and the fields to set; a field name must already exist as a custom field type, and the documented response has no body.

Input Parameters

array
required
Custom field updates to apply, one entry per credit memo.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CUSTOMERUpdate fields of a customer in ServiceTitan. Only the fields sent are changed, but custom_fields and tag_type_ids are treated as full lists: send every value you want to keep. To add or remove one tag, use ADD_CUSTOMER_TAG or REMOVE_CUSTOMER_TAG.

Input Parameters

string
Name of the customer.
string ("Residential" | "Commercial")
Type of customer.
boolean
Whether the customer is active. The provider guide says customers cannot be deactivated or reactivated through the API, so this field may be ignored.
object
Bill-To address of the customer record. When sent, every address field is required.
boolean
Customer has been flagged as Tax Exempt.
integer
required
Id of the customer.
boolean
Customer has been flagged as “do not mail”.
number
Credit Limit for the customer.
array
Ids of the tag types on the customer, sent as the full list.
array
Custom field values of the customer, each with typeId and value.
object
External data items to write on the customer. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
boolean
Customer has been flagged as “do not service”.
integer
Id of the customer’s payment term.
boolean
Customer has been flagged as National Account.
number
Credit Limit Balance for the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_CUSTOMER_CONTACTUpdate one contact entry on a customer in ServiceTitan. Only the fields sent are changed; if preferences is sent, all five of its flags are required. This is the customer’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.

Input Parameters

string
Short description about this contact, for example, “work #” or “Owner’s daughter - Kelly”.
string ("Phone" | "Email" | "Fax" | "MobilePhone")
Type of contact entry: Phone (landline), MobilePhone, Email or Fax.
string
The email, phone number, or fax number for the contact.
integer
required
Id of the contact entry, from the matching contacts list tool. This is a numeric id, not a contact GUID.
integer
required
Id of the customer.
object
Contact preference setting for Job Reminders and Marketing Updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_EMPLOYEEUpdate an office employee in ServiceTitan; only the fields sent are changed. business_unit_access_ids is a full replacement, and account_locked sets whether the account is locked.

Input Parameters

string
Employee name.
string
Email.
string
Login (Username).
integer
User role Id.
array
List of company positions. Whether it replaces or merges with the current positions is not documented.
string
Azure Active Directory User Id.
integer
required
Id of the employee.
string
Office phone.
array
List of employee’s custom fields, each with typeId and value.
boolean
Account Locked Status.
integer
Business unit Id. The spec allows null here, but leaving this out sends nothing, so it cannot be cleared through this tool.
string
Mobile phone.
array
Business Unit Access IDs. Full replacement. Requires ‘Business units filtering for employees’ feature flag, otherwise HTTP 400.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_EMPLOYEE_PAYROLL_SETTINGSUpdate the payroll settings of one office employee in ServiceTitan. hourly_rate is required on every call; the spec does not say whether other omitted fields are kept or cleared.

Input Parameters

string
The hire date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the manager.
integer
required
Id of the office employee.
number
required
The hourly rate. Required on every call.
string
The external payroll id.
boolean
Whether the employee should be included in payroll processing.
integer
Id of the payroll business unit (employee only).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_EQUIPMENT_SYSTEMUpdate a ServiceTitan equipment system by id. Omitted fields are left unchanged; equipment_ids, when sent, replaces the system’s whole equipment list (use ADD_EQUIPMENT_TO_EQUIPMENT_SYSTEM or REMOVE_EQUIPMENT_FROM_EQUIPMENT_SYSTEM to change one item), and an empty list for tags or custom fields clears them.

Input Parameters

string
Optional free-text memo.
string
The display name of the equipment system. Must be unique within the location.
array
Tag type IDs to associate with the system. Omit to leave the tags unchanged; send [] to remove all tags.
array
Equipment system custom field values, each with id, typeId and value. Omit to leave them unchanged; send [] to clear all custom fields.
array
Existing installed equipment IDs that should be in the system. This is a full replacement, not a delta. Omit to leave the equipment unchanged; send [] to remove all equipment from the system.
integer
required
Id of the equipment system to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_EQUIPMENT_TYPERename a ServiceTitan equipment type or change its active status, by id.

Input Parameters

string
Equipment type name.
boolean
Whether the equipment type is active.
integer
required
Id of the equipment type to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_ESTIMATEUpdate an estimate in ServiceTitan. This is a PUT with every field optional; whether omitted fields and items are kept or cleared is not documented, so read the estimate first and send the full intended values.

Input Parameters

number
Tax amount on the estimate.
string
Name of the estimate.
array
Line items of the estimate, each a pricebook service, material or equipment. Nested keys use the documented spelling (skuId, unitPrice).
string ("Open" | "Sold" | "Dismissed")
Estimate status: Open, Sold or Dismissed.
string
Summary text shown on the estimate.
integer
Id of the technician credited with the sale.
integer
required
Id of the estimate.
string ("None" | "NeedsApproval" | "Approved" | "NotApproved")
Review status: None, NeedsApproval, Approved or NotApproved.
integer
Id of the budget code the estimate is booked against.
number
Deposit requested, as a fixed amount.
Links to external documents shown with the estimate.
Whether this estimate is the recommended option for the customer.
number
Deposit requested, as a percentage of the estimate total.
boolean
Whether to apply the project’s default labels to the estimate.
boolean
Whether the deposit must be paid when the customer signs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_ESTIMATE_TEMPLATEUpdate an estimate template in ServiceTitan; only the fields sent are changed. Sending items replaces every item on the template, and summary and business_unit_id cannot be cleared once set.

Input Parameters

string ("Dynamic" | "Static")
Pricing mode: Static (prices fixed on the template, unitPrice needed on every item) or Dynamic (prices computed from the pricebook).
string
Customer-facing name of the estimate template.
array
Items of the template. When given, replaces every item on the template; leave out to keep the items. skuId, skuType, quantity and isAddOn are required on each item.
boolean
Whether the template is active.
string
Summary text of the template. Leave out to keep it unchanged. Once set, it cannot be cleared back to empty.
string
Internal name of the estimate template, shown to staff.
integer
Id of the business unit the template belongs to. Leave out to keep it unchanged. Once set, it cannot be cleared.
integer
required
Id of the estimate template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_EXPENSE_TRANSACTION_CUSTOM_FIELDSSet custom field values on one or more expense transactions in ServiceTitan. The request is all-or-nothing: an unknown custom field name or expense id returns 422 and no update is saved.

Input Parameters

array
required
Custom field updates to apply, one entry per expense transaction, each with objectId and customFields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_FINDINGUpdate a ServiceTitan finding by ID, including its text fields, urgency level, or archived and active status. Supply at least one field to change.

Input Parameters

string
Title summarizing the issue or observation (e.g., “Leaking pipe”, “Worn brake pads”).
boolean
Whether the finding is active.
boolean
Whether the finding has been archived and is no longer active.
integer
required
Id of the finding to update.
string
Detailed description of the issue, condition, or observation.
string ("NotSpecified" | "Low" | "Medium" | "High" | "Critical")
Priority level indicating how urgently the finding should be addressed.
string
Private notes for internal use, not visible to customers.
Suggested action or repair to address the finding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_FINDING_ATTACHMENTUpdate the file name, URL, or media type of an attachment on a ServiceTitan finding. Supply at least one field to change.

Input Parameters

string
URL of the uploaded file obtained from ServiceTitan’s findings upload endpoint, which is not available as a tool; whether other URLs are accepted is undocumented.
string ("Other" | "Image" | "VideoFile" | "VideoLink" | "Document")
Media type of the attachment.
string
Original file name (e.g., “motor-inspection.jpg”).
integer
required
Id of the finding that owns the attachment.
integer
required
Id of the finding attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_GL_ACCOUNTUpdate a general ledger (GL) account in ServiceTitan; only the fields sent are changed. Set active to false to deactivate the account, which is the only form of deletion: an account cannot be removed permanently.

Input Parameters

string
Account name.
string
Account type name; see LIST_GL_ACCOUNT_TYPES.
boolean
Whether the account is active; false deactivates it (soft delete).
string
Account number.
string
Account subtype.
integer
required
Id of the general ledger account.
string
Account description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_GROSS_PAY_ITEMUpdate a gross pay item in ServiceTitan and return its id. This is a PUT: payroll_id, amount, activity_code_id and date are required on every call, and the spec does not say whether optional fields left out are kept or cleared.

Input Parameters

string
required
Date of the gross pay item. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Memo of the gross pay item.
number
required
Amount of the gross pay item.
integer
Id of the invoice.
integer
required
Id of the payroll the item belongs to; see LIST_PAYROLLS.
integer
Id of the budget code.
integer
required
Id of the payroll activity code; see LIST_PAYROLL_ACTIVITY_CODES.
integer
Id of the business unit to use as the payout business unit. If not provided, the default applies: the employee or technician business unit when no invoice is set, the invoice business unit when one is.
integer
required
Id of the gross pay item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INSTALLED_EQUIPMENTUpdate fields of a ServiceTitan installed equipment record by id. Send only the fields to change; the spec marks none of them required. List fields such as custom_fields and tag_type_ids are sent as the lists you give.

Input Parameters

number
Cost of the equipment.
string
Free-text memo.
string
Name of the installed equipment.
string
Model name or number.
boolean
Whether the installed equipment record is active.
object
Parent of this equipment: another installed equipment record or an equipment system, given by id and type.
string ("Installed" | "Replaced")
Whether the equipment is currently installed or has been replaced.
string
Barcode identifier of the equipment.
array
Files to link to the equipment, each by URL with its type.
string
When the equipment was installed. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Manufacturer name.
array
Ids of the tag types to apply.
array
Custom field values to set, each with typeId and value.
string
Serial number of the equipment.
string
Date the equipment was manufactured. Date, e.g. 2025-01-31.
integer
Id of the equipment type; see LIST_EQUIPMENT_TYPES.
integer
required
Id of the installed equipment record to update.
string
Date the equipment was actually replaced. Date, e.g. 2025-01-31.
string
End of the manufacturer warranty. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Start of the manufacturer warranty. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
End of the service provider warranty. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Start of the service provider warranty. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVENTORY_ADJUSTMENTUpdate fields of an existing ServiceTitan inventory adjustment by id. Only the fields you send are changed, but items is sent as the full list: lines left out of it are removed.

Input Parameters

string
Adjustment date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Memo of the inventory adjustment.
string ("Adjustment" | "BeginningBalance" | "InventoryReturn" | "InventoryCount" | "AutoConsume" | "ReturnToWarehouse" | "Consignment" | "ConsignmentInventoryCount" | "ReturnToVendor" | "IntracompanyTransferIncoming" | "IntracompanyTransferOutgoing")
Adjustment type. Only manually-creatable types are accepted (Adjustment, BeginningBalance, Consignment).
array
Full replacement of the adjustment line items when provided. Lines with an id are updated, lines without an id are added, and existing lines absent from the list are removed.
integer
Inventory location Id the adjustment posts against.
integer
required
Id of the inventory adjustment to update.
object
External data items to attach to this adjustment. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
integer
Business unit Id.
string
Reference number of the inventory adjustment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVENTORY_ADJUSTMENT_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan inventory adjustments in a single request. Each operation names the adjustment by objectId and the custom fields to write; the documented response has no body.

Input Parameters

array
required
Custom field update operations, one entry per inventory adjustment. Each has objectId and customFields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVENTORY_BILL_CUSTOM_FIELDSSet custom field values on one or more inventory bills in ServiceTitan. Each operation names one inventory bill id and the fields to set; a field name must already exist as a custom field type, and the documented response has no body.

Input Parameters

array
required
Custom field updates to apply, one entry per inventory bill.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVENTORY_RECEIPT_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan inventory receipts in a single request. Each operation names the receipt by objectId and the custom fields to write; the documented response has no body.

Input Parameters

array
required
Custom field update operations, one entry per inventory receipt. Each has objectId and customFields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVENTORY_RETURNUpdate fields of an existing ServiceTitan vendor return by id. Only the fields you send are changed.

Input Parameters

number
Tax of the vendor return.
string
Memo of the vendor return.
array
Return items. Each needs id, skuId, quantity and cost. The spec does not say whether lines left out of the list are removed.
number
Shipping cost of the vendor return.
integer
required
Id of the vendor return to update.
string
Return date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
object
External data items to attach to this return. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
integer
Id of the budget code for the return.
number
Restocking fee of the vendor return.
integer
Id of the return type.
integer
Id of the business unit.
string
Reference number of the vendor return.
integer
Id of the inventory location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVENTORY_RETURN_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan inventory returns in a single request. Each operation names the return by objectId and the custom fields to write; the documented response has no body.

Input Parameters

array
required
Custom field update operations, one entry per inventory return. Each has objectId and customFields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVENTORY_RETURN_TYPEUpdate a ServiceTitan vendor return type by id. Only the fields you send are changed.

Input Parameters

string
Name of the return type.
boolean
Whether the return type is active.
boolean
Whether this is the default return type. The spec gives no description for this field.
integer
required
Id of the return type to update; also sent in the request body, where the spec documents the same id.
boolean
Whether returns of this type are included in sales tax. The spec gives no description for this field.
boolean
Whether this is the default return type for consignment. The spec gives no description for this field.
boolean
Whether the return type allows receiving vendor credits automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVENTORY_TRANSFERUpdate an existing ServiceTitan inventory transfer by id. The source location, transfer type, and date can only be changed while the transfer is Pending.

Input Parameters

string
Transfer date (editable only while Pending). RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Memo of the inventory transfer.
array
Full replacement of the transfer line items when provided. Lines with an id are updated, lines without an id are added, and active lines absent from the list are removed.
integer
Id of the job associated with the transfer.
integer
Transfer type Id (editable only while Pending).
integer
required
Id of the inventory transfer to update.
string
Required-by date of the inventory transfer. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
object
External data items to attach to this transfer. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
integer
Destination inventory location Id (editable while Pending, or pre-received for job transfers).
string
Reference number of the inventory transfer.
integer
Source inventory location Id (editable only while Pending).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVENTORY_TRANSFER_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan inventory transfers in a single request. Each operation names the transfer by objectId and the custom fields to write.

Input Parameters

array
required
Custom field update operations, one entry per inventory transfer. Each has objectId and customFields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVOICEUpdate an invoice’s header fields, line items or payment settlement status in ServiceTitan; only the fields sent are changed. Each entry in items needs description and quantity, and the documented response has no body, so read the invoice back with LIST_INVOICES to confirm.

Input Parameters

number
Tax amount.
array
Invoice line items. Each entry needs description and quantity.
string
Invoice number.
string
Invoice summary (HTML allowed).
integer
Id of the invoice type.
string
Invoice due date. Date in YYYY-MM-DD form, e.g. 2025-01-31.
array
Settlement updates for payments applied to this invoice.
number
Subtotal before tax.
string
Identifier assigned when the record was exported.
integer
required
Id of the invoice.
string
Invoice date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the tax zone; see LIST_TAX_ZONES.
string
Royalty date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Royalty memo.
integer
Rate sheet ID to assign to the invoice. Send null to clear the rate sheet; leave it out to keep the current rate sheet.
string ("NeedsReview" | "OnHold" | "Reviewed" | "PendingApproval" | "Rejected" | "ReadyForBilling" | "Invoiced")
Review status of the invoice.
integer
Id of the user the invoice is assigned to.
integer
Id of the budget code.
string ("Pending" | "Sent" | "Failed")
Indicates royalty status of invoice.
string
When the royalty was sent. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVOICE_CUSTOM_FIELDSSet custom field values on one or more invoices in ServiceTitan. Each operation names one invoice id and the fields to set; a field name must already exist as a custom field type, and the documented response has no body.

Input Parameters

array
required
Custom field updates to apply, one entry per invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVOICE_ITEMUpdate one line item on an invoice in ServiceTitan; item_id names the item to change, and description and quantity are required on every call.

Input Parameters

number
Cost per unit.
integer
Id of the pricebook SKU.
integer
required
Id of the existing invoice item to update.
number
required
Quantity.
string
Name of the pricebook SKU.
boolean
Whether the item is an add-on.
string
Customer signature.
integer
required
Id of the invoice.
number
Price per unit.
string
required
Item description (HTML allowed).
string
When the item was installed. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Service Date (Item Consumption date, stored as InvoiceItem.DateCreated). Optional; when omitted the item’s Service Date is left as-is. Must not fall in a closed accounting period. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the technician.
integer
Id of the budget code.
string
Name of the item group.
integer
Id of the item group’s root item.
integer
Id of the membership duration billing.
integer
Id of the inventory location.
string
Name of the inventory warehouse.
boolean
Set true to leave membership prices unchanged.
string
Technician acknowledgement signature.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVOICE_TASKUpdate the name, status, assignee, due date or description of a task on an invoice in ServiceTitan; only the fields sent are changed. task_id is a string id from LIST_INVOICE_TASKS. This is an invoice workflow task, not a Task Management task (CREATE_TASK).

Input Parameters

string
Task name.
string
Task status. The spec gives no list of values; reuse a status seen in LIST_INVOICE_TASKS.
string
required
Id of the invoice task (a GUID string), from LIST_INVOICE_TASKS.
string
When the task is due. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
Id of the invoice.
string
GUID of the user the task is assigned to.
string
Task description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_INVOICE_TEMPLATEUpdate a membership invoice template in ServiceTitan; only the top-level fields sent are changed. Whether items replaces or merges with the existing items is not documented, so read the template first and send the full intended item list.

Input Parameters

string
Invoice template name (used only for shared invoice templates).
array
Line items of the invoice template. Each item needs skuId, quantity, unitPrice and isAddOn; send id to change an existing item.
boolean
Whether the invoice template is active.
string
Creation date recorded on the template. Documented as writable; leave out on a normal update. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the user recorded as the template’s creator. Documented as writable; leave out on a normal update.
integer
required
Id of the membership invoice template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_JOBUpdate fields of a ServiceTitan job; only the fields sent are changed, and job status cannot be changed here. custom_fields and tag_type_ids replace the whole list, so include every value you want to keep.

Input Parameters

integer
required
ID of the job.
string
Job summary. HTML is accepted.
string
Priority of the job. The list filter documents Low, Normal, High, Urgent.
boolean
Whether the job is a no-charge job.
integer
ID of the Technician who sold the job.
integer
ID of the job’s campaign.
integer
ID of the job’s customer.
string
Customer PO.
integer
ID of job type.
integer
ID of the job’s location.
array
List of tag types. This list must describe the full list of tags on the job. If job A has tags X and Y and this field only contains a ID for tag X, then tag Y on job A will be removed.
array
List of custom fields and their values, each with typeId and value. This list must describe the full list of custom fields on the job: a custom field that is not in the list is removed from the job.
object
External data update model. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
integer
ID of the job that this job is a recall for. ServiceTitan clears it when null is sent, which this tool cannot send: a field left out is not changed.
string
Summary of work completed on the job. Private preview: available for specific accounts only.
integer
ID of the job’s business unit.
boolean
Indicates whether Dispatch Pro is enabled for this job.
object
Object that contains jobId, the ID of the job from which this job was generated, and employeeId, the ID of the office user or technician.
boolean
If set to true, update the business unit of invoice items on job’s invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_JOB_TYPEUpdate fields of a ServiceTitan job type; only the fields sent are changed. custom_field_type_ids replaces the assigned list unless custom_fields_update_mode is Merge.

Input Parameters

string
Name of the job type.
array
List of skills required to complete this job.
string
Text that is automatically added to job summary when booked.
integer
Average length of time for this job type. The unit is not stated on this field; the list filter documents seconds.
string
Level of urgency for this type of job.
boolean
When true, all jobs are considered no charge.
integer
required
ID of the job type.
array
Tags here will automatically be applied to jobs booked.
object
External data update model.
string
Class used to group job types.
number
A job is considered as converted if subtotal meets or exceeds this threshold.
array
Business Unit Ids associated with job type.
array
Custom field type IDs to assign to this job type. Order determines display order.
string ("Replace" | "Merge")
How custom_field_type_ids is applied. Replace (default) replaces all existing custom field type assignments with the list sent, so a type that is not sent is removed. Merge keeps the existing assignments and appends the new IDs.
string
Default action when an estimate is sold for this job type.
boolean
When true signature is required.
boolean
When true enforce recurring service event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_JOURNAL_ENTRYUpdate a journal entry’s status (Open or Closed) and custom fields in ServiceTitan. It cannot change lines or amounts; use REPLACE_JOURNAL_ENTRY for that. Custom fields not named are left as they are; a named custom field can be set to null but not deleted.

Input Parameters

string ("Open" | "Closed")
New status of the journal entry: Open or Closed.
object
Custom fields to create or update, as name-value pairs of strings. Existing fields not named here are not affected, and at most 5 custom fields per journal entry are supported. Send a null value to set a named field to null; this does not delete the field.
string
required
Id of the journal entry (a GUID string), from LIST_JOURNAL_ENTRIES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_JOURNAL_ENTRY_SYNC_STATUSRecord the result of syncing a journal entry to an external accounting system in ServiceTitan by setting its sync status. version_id is required when the status is Synced and must match the entry version that was synced.

Input Parameters

string
Message related to the new sync state.
integer
Journal entry version that was synced. Required when sync_status is Synced; not used for any other status.
string ("NotSynced" | "InProgress" | "Synced" | "OutOfSync" | "Error" | "Excluded")
required
Sync status to set on the journal entry: NotSynced, InProgress, Synced, OutOfSync, Error or Excluded.
object
Custom fields to create or update, as name-value pairs of strings. Existing fields not named here are not affected, and at most 5 custom fields per journal entry are supported. Send a null value to set a named field to null; this does not delete the field.
string
required
Id of the journal entry (a GUID string), from LIST_JOURNAL_ENTRIES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_LABOR_TYPEReplace a payroll labor type in ServiceTitan. This is a full update: name, code and active are required on every call, and leaving out service_code_id clears the labor type’s service code.

Input Parameters

string
required
Code for the payroll labor type.
string
required
Name of the payroll labor type.
boolean
required
Whether the payroll labor type is active. Required on every call; the spec says an update without it would reset the labor type to inactive.
integer
required
Id of the payroll labor type.
integer
Id of the labor SKU (service) to map this labor type to. This is the only optional field; leaving it out clears the labor type’s service code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_LEADUpdate fields of a lead in ServiceTitan. Only the fields sent are changed; status is not set here, use DISMISS_LEAD to dismiss.

Input Parameters

integer
required
Id of the lead.
string
Lead summary.
string
Zip provided for the lead.
string ("Low" | "Normal" | "High" | "Urgent")
Priority of the lead.
string
City provided for the lead.
string
Unit provided for the lead.
string
Email provided for the lead.
string
Phone number provided for the lead.
string
State provided for the lead.
integer
ID of the campaign.
integer
ID of job type.
string
Street provided for the lead.
string
Country provided for the lead.
integer
ID of the business unit.
string
Customer name provided for the lead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_LOCATIONUpdate fields of a location in ServiceTitan. Only the fields sent are changed, but custom_fields and tag_type_ids replace the full lists, so anything left out of them is removed.

Input Parameters

string
Name of the location.
boolean
Whether the location is active. The provider guide says locations cannot be deactivated or reactivated through the API, so this field may be ignored.
object
Address of the location record. When sent, street, unit, city, state, zip and country are all required.
integer
ID of the location’s customer.
integer
required
Id of the location.
integer
ID of the location tax zone.
array
List of tag type IDs. If location has tag types X and Y and this field only contains tag type X, then Y will removed from the location. If it is an empty list, all tags on the location will be removed.
array
List of custom fields and their values, each with typeId and value. This list must describe the full list of custom fields on the location: the value of any custom field left out is removed.
object
Optional model that contains a list of external data items that should be updated to this Location. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_LOCATION_CONTACTUpdate one contact entry on a location in ServiceTitan. Only the fields sent are changed; if preferences is sent, all five of its flags are required. This is the location’s own contact list, separate from the GUID person contacts managed with CREATE_CONTACT and CREATE_CONTACT_METHOD.

Input Parameters

string
Short description about this contact, for example, “work #” or “Owner’s daughter - Kelly”.
string ("Phone" | "Email" | "Fax" | "MobilePhone")
Type of contact entry: Phone (landline), MobilePhone, Email or Fax.
string
The email, phone number, or fax number for the contact.
integer
required
Id of the contact entry, from the matching contacts list tool. This is a numeric id, not a contact GUID.
integer
required
Id of the location.
object
Contact preference setting for Job Reminders and Marketing Updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_LOCATION_PREFERRED_TECHNICIANSet the preferred technician of a location in ServiceTitan. Both ids go in the path and no request body is sent; it replaces any technician set before.

Input Parameters

integer
required
Id of the location.
integer
required
Id of the technician to set as preferred for the location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_MEMBERSHIPUpdate a customer membership in ServiceTitan; only the fields sent are changed. status takes Active, Suspended, Expired, Canceled or Deleted, and recurring_service_action None deletes the membership’s existing recurring services. Explicit null clears to_date, location_id and recurring_location_id.

Input Parameters

string
Memo text field.
string ("Active" | "Suspended" | "Expired" | "Canceled" | "Deleted")
Status of the membership.
string
End date of the membership. Send null for an ongoing membership; leave it out to keep the current end date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Start date of the membership. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
ID of the user that was credited for the sale of this membership.
integer
Discount location ID of this membership. Send null to apply to all locations; leave it out to keep the current location.
integer
required
Id of the customer membership.
integer
Id of the payment type (cash, check, …) to bill with. Mutually exclusive with payment_method_id: set only one. With a payment type set, no stored payment method is charged automatically.
integer
ID of the Business Unit associated with this membership.
integer
Id of the stored payment method (card or bank account) to bill. Mutually exclusive with payment_type_id: set only one.
integer
Id of the invoice template used to bill this membership. If a shared settings template is given, a new invoice template is created from it for this membership.
integer
The location at which recurring services are scheduled. Send null for all locations; leave it out to keep the current location.
integer
The ID of the invoice optionally created upon membership cancellation in order to charge (or refund) the customer if deferred revenue balance is not 0.
number
The amount of deferred revenue that this membership should start with that is not accounted for in the sale task.
string
Next date the membership will be billed. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string ("None" | "Single" | "All")
How many of the customer’s locations get the recurring services: All, Single, or None. None deletes existing recurring services. Required when recurring_location_id is set.
integer
The ID of the service that will be used as the default to renew this membership.
integer
The ID of the invoice created upon membership cancellation in order to zero out the deferred revenue balance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_NON_JOB_APPOINTMENTReplace a ServiceTitan non-job appointment. This is a full update: technician, start, duration and name are required every time.

Input Parameters

string
required
Name of the non-job appointment, for example Training.
string
required
Start of the non-job appointment. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Date-time the repetition ends, used when end_type is On. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
boolean
Whether the non-job appointment repeats.
boolean
Whether the non-job appointment lasts the whole day.
string
Free-text summary of the non-job appointment.
string
required
Length of the non-job appointment as a TimeSpan string such as 02:00:00.
string ("Never" | "After" | "On")
How the repetition ends: Never, After a number of occurrences, or On a date.
integer
Repeat every N units of frequency.
string ("Daily" | "Weekly" | "Monthly" | "Yearly")
How often the non-job appointment repeats.
string
Days of the week the appointment repeats on. The string format is not documented.
integer
required
ID of the technician whose time is blocked.
integer
Number of occurrences, used when end_type is After.
integer
ID of the timesheet code that identifies how this time is paid.
boolean
Whether to clear this time on the dispatch board. Meaning taken from the field name; not documented.
boolean
Whether to clear this time in the technician’s view. Meaning taken from the field name; not documented.
integer
required
ID of the non-job appointment.
boolean
Whether the non-job appointment shows on the technician’s schedule even if there is no timesheet.
boolean
Whether the technician is left out of capacity planning for this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PAYMENTUpdate a customer payment record in ServiceTitan: type, paid date, memo, status and how it is split across invoices. type_id and splits are required on every call even though this is a PATCH.

Input Parameters

string
Deprecated by ServiceTitan; use user_memo.
boolean
Whether the payment is active.
array
required
How the payment is split across invoices, each with amount, invoiceId and invoiceNumber; required on every call.
string ("Pending" | "Posted" | "Exported")
Payment status: Pending, Posted or Exported.
string
When the payment was made. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
Id of the payment type; see LIST_PAYMENT_TYPES. Required on every call.
string
Payment authorization code.
string
Identifier assigned when the payment was exported.
string
Custom free-text message stored with the payment.
integer
required
Id of the payment.
string
Check number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PAYMENT_CUSTOM_FIELDSSet custom field values on one or more payments in ServiceTitan. Each operation names one payment id and the fields to set; a field name must already exist as a custom field type, and the documented response has no body.

Input Parameters

array
required
Custom field updates to apply, one entry per payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PAYMENT_STATUSSet the status (Pending, Posted or Exported) of one or more customer payments in ServiceTitan in one call. The documented response has no body, so read the payments back with LIST_PAYMENTS to confirm.

Input Parameters

string ("Pending" | "Posted" | "Exported")
required
Status to set on every listed payment: Pending, Posted or Exported.
array
required
List of payment ids whose status is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PAYROLL_ADJUSTMENTUpdate a payroll adjustment in ServiceTitan with a PUT. employee_id and posted_on are required on every call along with the employee_type query value; the spec does not say what happens to optional fields that are left out.

Input Parameters

string
Memo of the payroll adjustment.
number
Rate of the payroll adjustment.
number
Hours of the payroll adjustment.
number
The payroll adjustment amount.
number
Quantity of the payroll adjustment.
string
required
When the adjustment is posted. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the payroll adjustment invoice.
integer
required
Id of the employee or technician the adjustment is for.
string ("Technician" | "Employee")
required
Type of the person the adjustment belongs to: Technician or Employee. Required.
integer
Id of the payroll adjustment activity code.
integer
Id of the payroll adjustment business unit.
integer
required
Id of the payroll adjustment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PRICEBOOK_CATEGORYUpdate fields of a ServiceTitan pricebook category by ID and return the updated category. Supply at least one body field with a non-null value, or set parent_id to null.

Input Parameters

string
The name of the category.
string
The image to display as the category.
boolean
Active shows if this category is currently active.
integer
The position location of this item.
integer
The id of this category’s parent. Send null to make it a top-level category; leave it out to keep the current parent.
array
The images that will be used for the SKUs under this category. The spec does not say whether the list replaces or is added to the current one.
array
The videos that will be used for the SKUs under this category. The spec does not say whether the list replaces or is added to the current one.
integer
required
Id of the pricebook category to update.
string
A description that described the category.
string ("Services" | "Materials")
The category type: Services or Materials.
array
Ids of the business units that are associated with this category. The spec does not say whether the list replaces or is added to the current one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PRICEBOOK_DISCOUNT_OR_FEEUpdate fields of a discount or fee in the ServiceTitan pricebook by ID. Provide at least one non-null body field; categories and assets are sent as the lists supplied.

Input Parameters

string
Code of the discount or fee.
string ("Discount" | "Fee")
Discount or Fee: which kind of item this is.
number
Flat-rate bonus paid for this item.
number
Number of hours associated with the item.
number
Maximum amount that can be applied for this item.
boolean
Whether the item is active.
number
Percentage or flat amount to discount or add, as amount_type says.
array
Images, videos or PDFs to attach to the item. Each needs type and url.
string
Accounting account assigned to the item.
boolean
Set true to apply tax when the item is added to an estimate or invoice.
array
Ids of the categories technicians use to find the item.
string ("Percentage" | "Fixed")
Percentage or Fixed: whether amount is a percentage or a flat amount.
string
Description of the item. The spec gives its format as html.
string
Display name of the discount or fee.
object
External data to write on the item. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
boolean
Whether this item pays commission.
string
Budget cost code segment. Send budget_cost_type with it.
string
Budget cost type segment. Send budget_cost_code with it.
number
Percentage-rate bonus paid for this item.
string
Cross-sale group, tracked as a separate column on the Technical Performance Board.
integer
required
Id of the discount or fee to update.
boolean
Set true to let users enter a custom amount when applying this item.
boolean
Whether the item is excluded from payroll.
string
Intacct GL group name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PRICEBOOK_EQUIPMENTUpdate fields of an equipment item in the ServiceTitan pricebook catalog by ID. Provide at least one non-null body field; list fields such as categories and assets are sent as the lists supplied.

Input Parameters

string
Code of the item.
number
Cost paid to acquire the item.
number
Flat-rate bonus paid for the item.
number
Number of hours to install the equipment.
string
Model of the equipment.
number
Sale price of the item.
boolean
Whether the item is active.
array
Images, videos or PDFs to attach to the item. Each needs type and url.
string
Accounting account assigned to the item.
boolean
Whether the item is taxable.
array
Ids of upgrades that can be sold for this item.
array
Ids of the categories the item belongs to.
object
Dimensions of the equipment: height, width and depth.
string
Description displayed with the item. The spec gives its format as html.
number
Price when the item is sold as an add-on.
string
Name displayed with the item.
integer
required
Id of the pricebook equipment item to update.
boolean
Whether the equipment is part of inventory.
string
Name of the manufacturer.
number
Price when the item is sold to a member.
string
Name of the asset general ledger account for the item.
object
External data to write on the item. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
array
Other vendors the item can be acquired from. Each needs vendorId, cost and active.
boolean
Whether the cost is locked from editing.
object
Primary vendor the item is acquired from. vendorId, cost and active are required.
boolean
Whether the price is locked from editing.
boolean
Whether the item pays commission.
array
Services and materials recommended with this item, each with skuId and type (Service or Material).
string
Unit of measure of the item.
string
Budget cost code segment. Send budget_cost_type with it.
string
Budget cost type segment. Send budget_cost_code with it.
number
Percentage-rate bonus paid for the item.
string
Cross-sale group, tracked as a separate column on the Technical Performance Board.
number
Price when the item is sold to a member as an add-on.
array
Materials used with this equipment, each with skuId and quantity.
array
Ids of the variation items to add.
string
Name of the cost of sale general ledger account for the item.
object
Manufacturer warranty included with the item: duration (required) and description.
string
Intacct GL group name.
boolean
Whether the item is configurable equipment.
object
Service provider warranty included with the item: duration (required) and description.
boolean
Whether the estimated cost is left off the invoice when carried over from an estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PRICEBOOK_MATERIALUpdate fields of a material in the ServiceTitan pricebook by ID. Provide at least one non-null body field; fields left out are not sent.

Input Parameters

string
Code for the SKU.
number
The cost paid to acquire the material.
number
Flat-rate bonus paid for this task.
number
The number of hours associated with installing the material.
number
Price of this SKU when sold.
boolean
Whether the SKU is active.
array
Images, videos or PDFs attached to the SKU, each with type and url.
string
The accounting account assigned to this SKU.
boolean
Whether this SKU is taxable.
array
Ids of the categories this SKU belongs to.
string
Optional EPA registration number, up to 500 characters, when chemical tracking applies.
string
Description on the SKU that is displayed with the item. It can contain HTML.
boolean
When true, an EPA number and active ingredients may be recorded for this chemical material.
integer
required
Id of the pricebook material to update.
number
The price if the SKU is sold as an add-on item.
integer
Id of the cost type of the other direct cost.
string
Name that displays with the SKU.
boolean
Whether this material is part of your inventory.
number
The price if the item is sold to a member.
string
Name of the asset general ledger account for this item.
object
External data to write under one application GUID. patchMode Replace (the default) removes keys not listed; Merge changes only the listed keys.
array
Other vendors that you might go to acquire this SKU, each with vendorId, cost and active.
boolean
Whether the cost is locked from editing.
object
The primary vendor you use to acquire this SKU. vendorId, cost and active are required inside it.
boolean
Whether the price is locked from editing.
boolean
Whether this task pays commission.
string
The unit of measure used for this SKU.
string
The budget cost code segment for this material. budget_cost_type should also be provided.
string
The budget cost type segment for this material. budget_cost_code should also be provided.
number
Percentage-rate bonus paid for this task.
string
Optional active ingredients, up to 500 characters, when chemical tracking applies.
boolean
Whether this is deducted as a job cost.
number
The price if the SKU is sold to a member as an add-on item.
array
Ids of the added variation materials.
string
Name of the cost of sale general ledger account for this item.
boolean
Whether this is chargeable by default.
string
Intacct GL group name.
boolean
Whether this is a configurable material.
boolean
Whether the estimated cost is excluded from the invoice when carried over from an estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PRICEBOOK_MATERIAL_MARKUPReplace a material markup tier in the ServiceTitan pricebook by id. This is a full replacement: range_from, range_to, and percent are all required.

Input Parameters

number
required
Markup percent applied within the range.
number
required
Upper bound of the material cost range this markup tier applies to.
integer
required
Id of the material markup to update; also sent in the request body, where the spec documents the same id.
number
required
Lower bound of the material cost range this markup tier applies to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PRICEBOOK_SERVICEUpdate fields of a service in the ServiceTitan pricebook by ID. Supply at least one non-null field to change.

Input Parameters

string
Code for the SKU.
number
Flat rate bonus paid for this task.
number
Hours needed to complete this service.
number
Price of this SKU sold.
boolean
Active shows if the SKU is active or inactive.
array
Images, videos or PDFs attached to SKU.
string
The accounting account assigned to this SKU.
boolean
Is this SKU taxable.
boolean
Is a labor service.
array
Ids of the upgrades that can be sold for this service.
object
Description of the warranty included in this SKU.
array
Ids of the categories the service belongs to.
integer
required
Id of the pricebook service to update.
string
Description on the SKU that is displayed with the item.
number
The price of the SKU is sold as an add-on item.
string
Name that displays with the SKU.
number
The price if the item is sold to a member.
object
External data to write on the service. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
boolean
Whether the price is locked from editing.
boolean
PaysCommissions shows if this task pays commission.
array
Ids of the services and materials recommended with this service.
string
The Budget CostCode segment for this entity. (Note: BudgetCostType should also be provided).
string
The Budget CostType segment for this entity (Note: BudgetCostCode should also be provided).
number
Percentage rate bonus paid for this task.
string
A grouping of similar items that you’ll then be able to track as a separate columns on the Technical Performance Board.
array
Array of equipment linked to the service.
array
Array of materials linked to the service.
number
The price if the SKU is sold to a member as an add-on item.
string
Intacct GL Group Name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PROJECTUpdate fields of a ServiceTitan project; only the fields sent are changed. Whether a list field such as job_ids or project_manager_ids replaces or adds to the current list is not documented, so send the complete list you want the project to have; to add one job prefer Attach Job To Project.

Input Parameters

string
Project name.
array
IDs of the project’s jobs.
string
Project summary. HTML is accepted.
integer
Project status id.
integer
required
ID of the project.
string
Start date of the project. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
array
Project record’s custom fields.
object
External data update model.
integer
Project sub status id.
integer
Project type id.
array
IDs of business units for the project.
array
IDs of the project’s managers.
string
Actual completion date of the project. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Target completion date of the project. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PROPOSAL_TEMPLATEUpdate a proposal template in ServiceTitan; only the fields sent are changed. Sending estimate_assignments or business_unit_ids replaces the whole list, and an empty list removes them all.

Input Parameters

string
Name of the proposal template.
boolean
Whether the template is active.
string ("Publish" | "Draft")
Publication status: Publish or Draft.
string
Description of the proposal template. Omit to leave it unchanged; once set it cannot be cleared back to null.
integer
Id of the proposal type the template belongs to, from the proposal types list.
array
Ids of the business units the template is available to. When given, replaces the whole list; an empty list removes them all.
array
When provided, replaces all existing assignments (full replace, not merge), each with proposalTypeOptionId, estimateTemplateId and order. Omit to leave assignments unchanged. Pass an empty list to remove all assignments.
integer
required
Id of the proposal template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PURCHASE_ORDERUpdate fields of an existing ServiceTitan purchase order by id, supplying at least one non-null body field. When items is sent it replaces the item list: every active item left out is marked inactive.

Input Parameters

number
Tax of the purchase order.
string
Date of the purchase order. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Summary or memo for this purchase order.
array
New and updated items, sent as the full list: every active item of the purchase order that is not in this list is marked inactive.
integer
Id of the job for this purchase order.
object
Address the purchase order is shipped to. When sent, description and every address field are required.
integer
Id of the purchase order type for this purchase order.
number
Shipping cost of the purchase order.
integer
Id of the vendor for this purchase order.
integer
Id of the project for this purchase order.
string
Date the purchase order is required on. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the technician for this purchase order.
integer
Id of the budget code for this purchase order.
integer
Id of the business unit for this purchase order.
integer
required
Id of the purchase order to update.
integer
Id of the inventory location for this purchase order.
string
Vendor invoice number.
boolean
Whether this purchase order impacts the technician’s payroll.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PURCHASE_ORDER_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan purchase orders in a single request. Each operation names the purchase order by objectId and the custom fields to write by name.

Input Parameters

array
required
Custom field update operations, one per purchase order, each with objectId and customFields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PURCHASE_ORDER_MARKUPUpdate a ServiceTitan purchase order markup tier by id. All three values (range_from, range_to, percent) are required on every update.

Input Parameters

number
required
Markup percent applied within the range.
number
required
Upper bound of the range this markup tier applies to.
integer
required
Id of the purchase order markup to update.
number
required
Lower bound of the range this markup tier applies to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_PURCHASE_ORDER_TYPEUpdate a ServiceTitan purchase order type by id. Although sent as a partial update, the documented body requires every setting, so send the full set of values.

Input Parameters

string
required
Name of the Purchase Order Type.
boolean
required
Is the Purchase Order Type Active.
boolean
required
Should the Purchase Order Type be the default.
boolean
required
Whether weekends are skipped when the default required date is calculated.
object
required
Alert definition for the Purchase Order Type. All four email flags are required.
string ("None" | "ByValue")
required
Landed cost method for this PO type: None or ByValue.
boolean
required
Should the Purchase Order Type be included in the Purchase Order screen.
boolean
required
Should the Purchase Order Type be included in sales tax.
boolean
required
Should the Purchase Order be automatically received.
boolean
required
Should the Purchase Order Type be displayed to the technician on mobile.
boolean
required
When enabled, once a Job is set on a PO of this type it cannot be cleared.
integer
required
Id of the purchase order type to update.
boolean
required
Should the Purchase Order Type be the default for consignment.
boolean
required
Require job before receipt.
boolean
required
Should the Purchase Order Type allow technicians to send POs.
boolean
required
Should the Purchase Order Type be excluded from job costing.
boolean
required
Should the Purchase Order Type impact technician payroll.
boolean
required
Whether to include tax in fully landed cost.
integer
required
Default number of days to offset required date.
boolean
required
Should the Purchase Order Type copy purchase order items to invoice when received.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_RECURRING_SERVICEUpdate a location recurring service in ServiceTitan; only the fields sent are changed. Service events are generated from the recurrence fields, but whether a change regenerates events that already exist is not documented.

Input Parameters

string
Memo.
string
Recurring service name.
boolean
Whether the recurring service is active.
string ("Low" | "Normal" | "High" | "Urgent")
Priority of the recurring service.
string
Start date of the recurring service. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the campaign.
string
Job summary.
integer
Id of the job type.
array
Ids of the tag types associated with this location recurring service.
string ("Continuous" | "NumberOfVisits")
Recurrence duration type.
string
Start time of day of the generated jobs, as a duration string such as 09:00.
integer
Duration length for the given duration type.
string ("Weekly" | "Monthly" | "Seasonal" | "Daily" | "NthWeekdayOfMonth")
Recurrence type: Weekly, Monthly, Seasonal, Daily or NthWeekdayOfMonth.
string ("None" | "First" | "Second" | "Third" | "Fourth" | "Last")
Week of the month the service recurs in when recurrence_type is NthWeekdayOfMonth. Used with recurrence_day_of_nth_week.
integer
Id of the business unit.
array
Months in which the service occurs, for a Seasonal recurrence type.
integer
Id of the invoice template.
integer
Recurrence interval for the recurrence type. Can be 0 when recurrence_type is Seasonal.
integer
required
Id of the location recurring service.
number
Estimated payroll cost.
array
Days of the week on which the service recurs when recurrence_type is Weekly.
array
Ids of the preferred technicians for this location recurring service.
integer
Id of the recurring service type.
string ("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")
Day of the week the service recurs on when recurrence_type is NthWeekdayOfMonth. Used with recurrence_week.
integer
Id of the invoice template for the second year and after, for ongoing memberships.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_TAG_TYPEUpdate a tag type in ServiceTitan; only the fields sent are changed. Setting active to false deactivates the tag type; there is no delete endpoint.

Input Parameters

string
Code associated with the tag type, at most 20 characters.
string
Name of the tag type.
string
Color of the tag type as a 6-digit hex string, for example #FF0000.
boolean
Whether the tag type is active.
string ("Medium" | "High")
Importance of the tag type: Medium or High.
integer
required
Id of the tag type.
boolean
Whether tags of this type count as a sales opportunity.
boolean
Whether tags of this type are shown on the dispatch board.
boolean
Whether tags of this type may be used on timesheet activities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_TECHNICIANUpdate a technician in ServiceTitan; only the fields sent are changed. zone_ids and project_label_ids replace the whole list, and account_locked true locks the technician’s account.

Input Parameters

string
Biography, as HTML.
object
Home address. street and city are required when it is sent.
string
Memo, as HTML.
string
Technician name.
string
Email address.
string
Login (user name).
integer
Id of the user role, from LIST_USER_ROLES.
array
Ids of all of the technician’s zones. Replaces the whole list.
array
Company positions of the technician.
string
Team name (not the team id).
number
Daily revenue goal.
string ("AllScheduledDispatchedWorking" | "NextScheduledDispatchedWorking" | "DispatchedWorking" | "NextScheduledDispatchedWorkingToday" | "AllScheduledDispatchedWorkingToday" | "AllScheduledDispatchedWorkingFiveDays" | "NextScheduledDispatchedWorkingTodayTomorrow" | "AllScheduledDispatchedWorkingTodayTomorrow" | "Next2ScheduledDispatchedWorkingToday")
Upcoming appointment visibility.
string
Azure Active Directory user id.
number
Hourly burden rate.
string ("NonManagedTech" | "ManagedTech" | "ManagedInstaller")
License type.
integer
Id of the technician’s main zone.
string
Technician’s phone number.
array
Custom field values of the technician, each with typeId and value.
integer
required
Id of the technician.
boolean
Account locked status. true locks the technician’s account.
integer
Id of the business unit, from LIST_BUSINESS_UNITS.
array
Project label ids. Replaces the whole list. Requires the ‘Budget vs Actual’ feature flag, otherwise HTTP 400.
string ("AllJobs" | "LastThreeDays" | "LastSevenDays" | "LastMonth")
Appointment history visibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_TECHNICIAN_PAYROLL_SETTINGSUpdate the payroll settings of one technician in ServiceTitan. hourly_rate is required on every call; the spec does not say whether other omitted fields are kept or cleared, except pay_type, which is left unchanged when omitted.

Input Parameters

string ("Both" | "Commission" | "Timesheet")
The pay type (technician only): Both, Commission or Timesheet. Omit to leave the current value unchanged.
string
The hire date. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the manager.
number
required
The hourly rate. Required on every call.
array
Custom payroll fields to update (technician only), each with typeId and an optional value.
integer
required
Id of the technician.
string
The external payroll id.
boolean
Whether the employee should be included in payroll processing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_TECHNICIAN_SHIFTUpdate fields of a ServiceTitan technician shift; only the fields sent are changed. The technician and repeat settings cannot be changed here.

Input Parameters

string
When the shift ends. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Longer explanation of the shift.
string
When the shift begins. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
string
Title of the shift.
string ("Normal" | "OnCall" | "TimeOff")
Type of shift.
integer
Timesheet code ID of the shift.
integer
required
ID of the technician shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_TIMESHEET_ACTIVITYReplace a timesheet activity in ServiceTitan. This is a PUT: activity_type_id, start_time, tag_type_ids and active are required on every call, the request has no employee field so the employee cannot be changed, and the spec does not say whether optional fields left out are cleared.

Input Parameters

string
Memo or notes related to the activity.
boolean
required
Whether the activity is active.
integer
Id of the job associated with the activity.
string
End time of the activity. Optional. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
Id of the project associated with the activity.
string
required
Start time of the activity. RFC 3339 UTC date-time, e.g. 2025-01-31T00:00:00Z.
integer
required
Id of the timesheet activity.
number
Miles driven associated with the activity.
array
required
Ids of the tag types associated with the activity. Required by the spec; whether an empty list is accepted is not documented.
integer
Id of the labor type associated with the activity; see LIST_LABOR_TYPES.
string
Label of the project associated with the activity.
integer
Id of the appointment associated with the activity.
integer
Id of the budget code associated with the activity.
integer
required
Id of the activity type; see LIST_TIMESHEET_ACTIVITY_TYPES.
string
Name of the budget code associated with the activity.
integer
Id of the non-job event assignment associated with the activity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_TRUCKUpdate a ServiceTitan truck by id: name, memo, warehouse, template, assigned technicians, or active status.

Input Parameters

string
Memo of the truck.
string
Truck name.
boolean
Whether the truck is active.
integer
required
Id of the truck to update.
integer
Id of the inventory template for this truck.
integer
Id of the warehouse for this truck.
object
External data items to attach to this truck. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
array
Ids of the technicians to associate with this truck. The spec does not say whether the list replaces or adds to the current one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_VENDORUpdate fields of an existing ServiceTitan inventory vendor by ID. Supply at least one body field; fields left out are not sent.

Input Parameters

string
Contact fax of the vendor.
string
Memo of the vendor.
string
Name of the vendor.
array
Tags of the vendor, each with tagTypeId. The spec does not say whether this list replaces the existing tags.
string
Contact email of the vendor.
string
Contact phone of the vendor.
boolean
Whether the vendor is active.
object
Address of the vendor. When sent, street, unit, city, state, zip and country are all required.
number
Default tax rate.
string
Contact last name.
integer
required
Id of the vendor to update.
string
Contact first name.
object
External data items to attach to this vendor. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.
string ("Manual" | "EmailAsExcel" | "EmailAsPdf" | "EmailAsPdfRollupView" | "Electronic" | "MarkAsSent" | "EmailAsExcelAndPdf" | "VendorPortal")
Default purchase order delivery method.
integer
Id of the payment term.
array
Contacts at the vendor who receive purchase order emails, each with name and email, and id to update an existing contact. The spec does not say whether this list replaces the existing contacts.
integer
Id of the remittance vendor.
boolean
Whether this vendor is used for truck replenishment.
string
Vendor QuickBooks item.
boolean
Whether purchase order creation on mobile is restricted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_VENDOR_CUSTOM_FIELDSSet custom field values on one or more ServiceTitan vendors in a single request. Each operation names the vendor by objectId and the custom fields to write by name.

Input Parameters

array
required
Custom field update operations, one per vendor, each with objectId and customFields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_WAREHOUSEUpdate the external data attached to a ServiceTitan warehouse by id. External data is the only warehouse field this endpoint can change.

Input Parameters

integer
required
Id of the warehouse to update.
object
External data items to attach to this warehouse. applicationGuid and externalData are required; patchMode Replace (default) drops keys not sent, Merge keeps them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPDATE_ZONEUpdate fields of a ServiceTitan dispatch zone; only the fields sent are changed. Whether a list field such as zips, cities or business_unit_ids replaces or adds to the current list is not documented, so send the complete list you want the zone to have.

Input Parameters

string
Name of the zone.
array
Zip codes assigned to the zone.
array
Cities assigned to the zone.
integer
required
ID of the zone.
array
LOCN numbers assigned to the zone.
array
IDs of the service days assigned to the zone.
array
IDs of the business units assigned to the zone.
array
Territory numbers assigned to the zone.
boolean
Whether the service days option is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPSERT_ESTIMATE_ITEMAdd a line item to an estimate in ServiceTitan, or update an existing one when item_id is given. One item per call. With item_id the existing item is overwritten; whether fields left out are kept or cleared is not documented, and the add-or-update reading comes from the schema and ServiceTitan’s guide, not the spec.

Input Parameters

integer
Id of the pricebook SKU (service, material or equipment) for this line.
integer
Id of an existing estimate item to update; leave out to add a new item. This use is inferred from the schema; the spec does not describe the field.
number
Quantity.
string
Name of the pricebook SKU.
boolean
Whether this line is an add-on.
number
Cost per unit to the business.
boolean
Whether the line is charged to the customer.
number
Price per unit charged to the customer.
string
Item description; HTML is accepted.
integer
required
Id of the estimate.
integer
Id of the budget code for this line.
integer
Id of the parent item when this line is an add-on of another item.
string
Name of the item group this line belongs to.
integer
Id of the root item of the item group this line belongs to.
boolean
Whether to apply the project’s default labels to this line.
integer
Id of the membership duration/billing option, when the line sells a membership. Get the options from the membership type duration billing items.
boolean
Set true to keep the given price instead of applying membership pricing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICETITAN_UPSERT_PROJECT_DAILY_LOGCreate or update a ServiceTitan project daily log for one date, changing only the fields and sections sent and creating a log if none exists. When sending inputs or summaries, provide all six sections in that object.

Input Parameters

string ("None" | "OnTrack" | "AtRisk" | "OffTrack")
Overall health status of the project as of this daily log.
object
Raw section content entered by the user. Omit entirely to leave every section untouched. The schema lists all six sections as required when this object is sent, although the provider text says a single section may be omitted.
string
required
Date of the daily log, in yyyy-MM-dd format, e.g. 2025-01-31.
object
Generated/AI-summarized version of each section, independently overwritable from the raw content in inputs. Omit entirely to leave every section’s summary untouched. All six sections are required when this object is sent.
integer
required
The project ID.
string
Generated executive summary of the whole daily log. Unlike the sections in summaries, there is no corresponding raw-content field for this; it is overwritable directly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not