Name: Slashspace
Author: Praneeth Pike

What your chats can do

Showing 500 of 585 tools from ServiceTitan.

Activate Employee AccountActivate a ServiceTitan employee's login account.
Activate Technician AccountActivate a ServiceTitan technician's login account with the required license type and, optionally, assign a truck.
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.
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.
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.
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.
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.
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.
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.
Assign Technicians to AppointmentAssign one or more technicians to a ServiceTitan job appointment. Returns the appointment.
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.
Attach Job to ProjectAttach an existing ServiceTitan job to a project. Takes no body.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Confirm AppointmentMark a ServiceTitan job appointment as confirmed. Takes no body; the appointment's isConfirmed flag becomes true.
Create Adjustment InvoiceCreate an adjustment invoice against an existing invoice in ServiceTitan, for example a refund or a write-off; adjustment_to_id names the invoice being adjusted. It cannot create an ordinary job invoice, and the response is a bare integer that the spec does not describe.
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.
Create Arrival WindowCreate a ServiceTitan arrival window with a start time and duration for a set of business units.
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.
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.
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.
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.
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.
Create CampaignCreate a marketing campaign in ServiceTitan. name, business_unit_id, category_id and active are required.
Create Campaign CategoryCreate a marketing campaign category in ServiceTitan. Returns only the new category's id.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Create Equipment TypeCreate an equipment type in ServiceTitan for classifying installed equipment.
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.
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.
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.
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.
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.
Create GL AccountCreate a general ledger (GL) account in ServiceTitan and return the created account. The spec marks no field as required; use LIST_GL_ACCOUNT_TYPES for valid type names.
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.
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.
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.
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.
Create Inventory ReceiptRecord a receipt of items against an existing ServiceTitan purchase order. items lists each SKU received with its quantity and cost.
Create Inventory ReturnCreate a vendor return in ServiceTitan inventory, recording items sent back to a vendor from an inventory location.
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.
Create Invoice TaskCreate a task on an invoice in ServiceTitan from a task template. template_id is required and no tool in this toolkit lists invoice task templates, so the id must come from the user or from an existing task's template_id. This is an invoice workflow task, not a Task Management task (CREATE_TASK).
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.
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.
Create Job AttributionAttribute an existing job to a web session in ServiceTitan Marketing Ads. It records attribution only; the job must already exist.
Create Job NoteAdd a note to a ServiceTitan job, optionally pinned to the top.
Create Job TypeCreate a ServiceTitan job type with its name, priority, duration, business units, skills and default tags.
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.
Create Labor TypeCreate a payroll labor type in ServiceTitan and return its id. name, code and active are all required.
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.
Create Lead Follow UpSchedule a follow-up on a lead in ServiceTitan by setting the next follow-up date, with an optional note.
Create Lead NoteAdd a note to a lead in ServiceTitan.
Create LocationCreate a location (service address) in ServiceTitan under an existing customer. name, address and customer_id are required.
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.
Create Location NoteAdd a note to a location in ServiceTitan. Set add_to_customer to copy the same note to the location's customer.
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.
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.
Create Opt OutsOpt one or more phone numbers out of contact in ServiceTitan. The whole request fails if any number cannot be parsed, and a number already opted out globally cannot be opted out for marketing.
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.
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.
Create Pricebook CategoryCreate a category in the ServiceTitan pricebook, as a Services or Materials category. Set parent_id to create it as a subcategory.
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.
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.
Create Pricebook MaterialCreate a material in the ServiceTitan pricebook, with cost, pricing, vendors, and categories. Only code and description are required.
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.
Create Pricebook ServiceCreate a service in the ServiceTitan pricebook, with pricing, warranty, categories, and linked materials and equipment. Only code and description are required.
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.
Create Project NoteAdd a note to a ServiceTitan project, optionally pinned to the top.
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.
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.
Create Purchase Order MarkupCreate a purchase order markup tier in ServiceTitan: a from/to range and the markup percent applied to it.
Create Purchase Order TypeCreate a purchase order type in ServiceTitan, with its receiving, tax, payroll, and alert settings. Most settings are required, not optional.
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.
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.
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.
Create TeamCreate a ServiceTitan dispatch team with a name and active flag.
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.
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.
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.
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.
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.
Create TruckCreate a truck inventory location in ServiceTitan. warehouse_id and name are required.
Create VendorCreate an inventory vendor (supplier) in ServiceTitan. The vendor's main address is required.
Create Web Booking AttributionAttribute an existing booking to a web session in ServiceTitan Marketing Ads. It records attribution only; the booking must already exist.
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.
Create ZoneCreate a ServiceTitan dispatch zone from zip codes, cities, territory numbers, service days and business units.
Deactivate Employee AccountDeactivate a ServiceTitan employee's login account.
Deactivate Estimate TemplateDeactivate an estimate template in ServiceTitan. The template is not removed: it becomes inactive and stops appearing in active-only lists.
Deactivate Proposal TemplateDeactivate a proposal template in ServiceTitan. The template is not removed and can be reactivated by updating it with active true.
Deactivate Technician AccountDeactivate a ServiceTitan technician's login account.
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.
Delete Booking ContactRemove one contact entry from a booking in ServiceTitan for a given booking provider. The booking itself is kept.
Delete ContactDelete a contact in ServiceTitan by its GUID. To keep the record but hide it, set is_archived with UPDATE_CONTACT instead.
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.
Delete Contact RelationshipRemove the link between a contact and a customer, location or booking in ServiceTitan. The contact itself is kept.
Delete Customer ContactRemove one contact entry from a customer in ServiceTitan.
Delete Customer NoteDelete one note from a customer in ServiceTitan.
Delete Equipment SystemDelete a ServiceTitan equipment system by id.
Delete Estimate ItemRemove one line item from an estimate in ServiceTitan. The removal is permanent.
Delete Finding AttachmentRemove an attachment from a ServiceTitan finding, by finding id and attachment id.
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.
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.
Delete Job AttachmentDelete one attachment from a job in ServiceTitan. The spec documents no way to restore a deleted attachment.
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.
Delete Location ContactRemove one contact entry from a location in ServiceTitan.
Delete Location NoteDelete one note from a location in ServiceTitan.
Delete Non Job AppointmentDelete a ServiceTitan non-job appointment by its ID.
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.
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.
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.
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.
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.
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.
Delete Project Daily Log AttachmentDelete one attachment from a ServiceTitan project daily log. The file is removed from the log.
Delete Purchase Order MarkupDelete a ServiceTitan purchase order markup tier by id.
Delete TeamDelete a ServiceTitan dispatch team by its ID.
Delete Technician ShiftDelete one ServiceTitan technician shift by its ID.
Delete Technician SkillRemove a skill from a ServiceTitan technician by deleting the technician-skill association, whose ID has the form {technicianId}_{skillId}.
Delete Timesheet ActivityDelete a timesheet activity in ServiceTitan by its id. The recorded time is removed; the spec documents no way to restore it.
Delete ZoneDelete a ServiceTitan dispatch zone by its ID.
Detach Job EquipmentDetach one or more equipment items from a ServiceTitan job in a single call. Returns no content. 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.
Detach Job from ProjectDetach a ServiceTitan job from whichever project it belongs to. Only the job ID is given; the project is not named.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Export Job HistoryExport the status history of all ServiceTitan jobs in bulk as a continuation feed. For one job use Get Job History.
Export Job NotesExport notes from all ServiceTitan jobs in bulk as a continuation feed. For the notes of one job use List Job Notes.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Export Project NotesExport notes from all ServiceTitan projects in bulk as a continuation feed. For the notes of one project use List Project Notes.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Get Arrival WindowGet one ServiceTitan arrival window by its ID.
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.
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.
Get Booking Provider TagGet one booking provider tag in ServiceTitan by its id.
Get Business HoursGet the ServiceTitan business hours: the open time ranges for weekdays, Saturday and Sunday. Returns one object, not a list.
Get Business UnitGet one business unit in ServiceTitan by id, including its name, address, email and phone.
Get CallGet one phone call in ServiceTitan by id, with the linked job, customer, campaign and agent.
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.
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.
Get CampaignGet one marketing campaign in ServiceTitan by id.
Get Campaign CategoryGet one marketing campaign category in ServiceTitan by id.
Get Campaign CostGet one campaign cost record in ServiceTitan by the cost record's id, not the campaign id.
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.
Get Cancel Reasons by Job IDsGet the cancel reason recorded on each of the given ServiceTitan jobs. Requires job IDs; for the catalogue of available reasons use List Job Cancel Reasons.
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.
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.
Get Contact MethodGet one contact method of a contact in ServiceTitan. Both ids are GUIDs.
Get Contact Method PreferenceGet one communication preference of a contact method in ServiceTitan by preference name. Names come from LIST_CONTACT_PREFERENCE_TYPES.
Get CustomerGet one customer in ServiceTitan by id, including bill-to address, balance, custom fields and tags.
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.
Get EmployeeGet one office employee in ServiceTitan by id, including name, email, phone, role and positions.
Get Employee Payroll SettingsGet the payroll settings of one office employee in ServiceTitan. Use GET_TECHNICIAN_PAYROLL_SETTINGS for a technician.
Get Equipment SystemGet one ServiceTitan equipment system by id, including the installed equipment attached to it.
Get Equipment TypeGet one ServiceTitan equipment type by id.
Get EstimateGet one estimate in ServiceTitan by its id, including its status, totals and line items.
Get Estimate TemplateGet one estimate template in ServiceTitan by its id, with its items.
Get Expense TransactionGet one expense transaction in ServiceTitan by its id. Use LIST_EXPENSE_TRANSACTIONS to find the id.
Get FindingGet one ServiceTitan finding by id.
Get Finding AttachmentGet one attachment of a ServiceTitan finding, by finding id and attachment id.
Get GL AccountGet one general ledger (GL) account in ServiceTitan by its id. Use LIST_GL_ACCOUNTS to find the id.
Get Hold Reasons by Job IDsGet the hold reason recorded on each of the given ServiceTitan jobs and on their appointments. Requires job IDs; for the catalogue of available reasons use List Job Hold Reasons.
Get Installed EquipmentGet one ServiceTitan installed equipment record by id.
Get Invoice TemplateGet one membership invoice template in ServiceTitan by its id, with its line items and total.
Get JobGet one ServiceTitan job by its ID, including customer, location, job type, status and first and last appointment IDs.
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.
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.
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.
Get Job TypeGet one ServiceTitan job type by its ID.
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.
Get Labor TypeGet one payroll labor type in ServiceTitan by its id. Use LIST_LABOR_TYPES to find the id.
Get LeadGet one lead in ServiceTitan by id. A lead is an opportunity to book a job that has not converted yet.
Get LocationGet one location in ServiceTitan by id. A location is the service address where work is done and belongs to exactly one customer.
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.
Get MembershipGet one customer membership in ServiceTitan by its id, including status, dates, billing template and payment settings.
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.
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.
Get Payment TermGet one payment term (for example net 30) in ServiceTitan by its id. Payment terms are read-only through the API.
Get Payment TypeGet one payment type in ServiceTitan by its id. Use LIST_PAYMENT_TYPES to find the id.
Get Payroll Activity CodeGet one payroll activity code (earning code) in ServiceTitan by its id. Use LIST_PAYROLL_ACTIVITY_CODES to find the id.
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).
Get Pricebook CategoryGet one ServiceTitan pricebook category by id, including its subcategories.
Get Pricebook Discount or FeeGet one discount or fee from the ServiceTitan pricebook by id.
Get Pricebook EquipmentGet one equipment item from the ServiceTitan pricebook catalog by id.
Get Pricebook MaterialGet one material from the ServiceTitan pricebook by id.
Get Pricebook Material MarkupGet one material markup tier from the ServiceTitan pricebook by id.
Get Pricebook ServiceGet one service from the ServiceTitan pricebook by id, including its linked materials and equipment.
Get ProjectGet one ServiceTitan project by its ID, including status, customer, location, managers and key dates.
Get Project Daily LogGet one daily log of a ServiceTitan project by its ID, with health, section notes, summaries and the attachment list.
Get Project StatusGet one ServiceTitan project status definition by its ID. This is the status catalogue entry, not the status of a project.
Get Project Sub StatusGet one ServiceTitan project sub status definition by its ID.
Get Project TypeGet one ServiceTitan project type by its ID.
Get Proposal TemplateGet one proposal template in ServiceTitan by its id, with its estimate assignments.
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.
Get Purchase OrderGet one ServiceTitan purchase order by id, including its items and current status.
Get Purchase Order MarkupGet one ServiceTitan purchase order markup tier by id.
Get Recurring ServiceGet one location recurring service in ServiceTitan by its id, including its recurrence schedule and invoice template ids.
Get Recurring Service TypeGet one recurring service type in ServiceTitan by its id.
Get Remittance VendorGet one remittance vendor in ServiceTitan by its id. Use LIST_REMITTANCE_VENDORS to find the id.
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.
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.
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.
Get Router PerformanceGet performance counts for one Scheduling Pro router in ServiceTitan over a time window: sessions opened and interacted with, split by scheduler. Both window bounds are required.
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.
Get Service AgreementGet one service agreement in ServiceTitan by id, with its price, dates, status and terms.
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.
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.
Get TeamGet one ServiceTitan dispatch team by its ID.
Get TechnicianGet one technician in ServiceTitan by id, including name, contact details, home address, zones and license type.
Get Technician Payroll SettingsGet the payroll settings of one technician in ServiceTitan. Use GET_EMPLOYEE_PAYROLL_SETTINGS for an office employee.
Get Technician ShiftGet one ServiceTitan technician shift by its ID.
Get Technician SkillGet one ServiceTitan technician skill by its ID, which is a string of the form {technicianId}_{skillId}.
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.
Get Timesheet ActivityGet one timesheet activity in ServiceTitan by its id. Use LIST_TIMESHEET_ACTIVITIES to find the id.
Get Timesheet Activity CategoryGet one timesheet activity category in ServiceTitan by its id. Use LIST_TIMESHEET_ACTIVITY_CATEGORIES to find the id.
Get Timesheet Activity TypeGet one timesheet activity type in ServiceTitan by its id. Use LIST_TIMESHEET_ACTIVITY_TYPES to find the id.
Get Timesheet CodeGet one timesheet code in ServiceTitan by its id. Use LIST_TIMESHEET_CODES to find the id.
Get VendorGet one ServiceTitan inventory vendor by id, including contact details, tax rate, and delivery option.
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.
Get ZoneGet one ServiceTitan dispatch zone by its ID, including its zip codes, cities, service days, business units and technicians.
Hold AppointmentPut a ServiceTitan job appointment on hold with a hold reason and memo. Get the reason ID from List Job Hold Reasons.
Import Sms Opt InsRecord SMS marketing opt-ins in ServiceTitan for phone numbers whose consent was collected outside it. Send only numbers whose owners agreed to receive text messages.
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.
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.
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.
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.
List AP CreditsList accounts-payable credits (vendor credits) in ServiceTitan, one page per call. Filter by ids, sync status, or created or modified dates.
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.
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.
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.
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.
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.
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.
List Bank DepositsList bank deposits in ServiceTitan, one page per call. Filter by deposit date, review status, deposit status, sync status or gross amount.
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.
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.
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.
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.
List Budget CodesList company-level ServiceTitan budget codes, one page per call, optionally filtered by budget code, segment or segment item IDs.
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.
List Budget Code Segment ItemsList the items of one company-level budget code segment in ServiceTitan, one page per call. Set include_children to get nested child items.
List Budget Code SegmentsList the company-level budget code segments of the ServiceTitan work breakdown structure. For the segments of one project use List Project Budget Code Segments.
List Business UnitsList business units in ServiceTitan, the divisions of the company that revenue and work are tracked and reported under.
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.
List CallsList phone calls recorded in ServiceTitan, inbound and outbound, filtered by campaign, agent, phone number, minimum duration, tag or created/modified time.
List Campaign CategoriesList marketing campaign categories in ServiceTitan, one page per call. Categories group campaigns; they are not pricebook categories.
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.
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.
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.
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.
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.
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.
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.
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.
List Contact RelationshipsList the customers, locations and bookings a contact is linked to in ServiceTitan, one page per call.
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.
List Contacts For RelationshipList the contacts in ServiceTitan attached to one relationship id, one page per call. Relationship ids come from LIST_CONTACT_RELATIONSHIPS.
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.
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.
List Credit MemosList customer credit memos in ServiceTitan, one page per call. Filter by the invoices they were applied to, dates, status, batch, business unit, total or balance; filtering by custom field is not supported.
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.
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.
List Customer NotesList the notes on one customer in ServiceTitan, one page per call.
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.
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.
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.
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.
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.
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.
List Estimate ItemsList estimate line items in ServiceTitan across estimates, or for one estimate when estimate_id is given.
List EstimatesList estimates in ServiceTitan, filtered by job, project, location, seller, status, total amount, or sold/created/modified time.
List Estimate Status ChangesReturn the status change history of one estimate in ServiceTitan, each with its UTC timestamp. Not paged.
List Estimate TemplatesList estimate templates in ServiceTitan, the reusable sets of pricebook items that estimates and proposal templates are built from.
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.
List Expense TransactionsList expense transactions (for example card expenses) in ServiceTitan, one page per call. Filter by number, vendor name, employee, status, source system, cost or transaction date; the NotSet expense status is rejected with 400.
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.
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.
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.
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).
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
List Job AttachmentsList the files attached to one job in ServiceTitan. The spec documents no response schema, so the body is returned unchanged under data.
List Job Canceled LogsList the canceled-log entries of one ServiceTitan job, one page per call; each entry records a cancellation of that job.
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.
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.
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.
List Job NotesList the notes on one ServiceTitan job, one page per call.
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.
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.
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.
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.
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.
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.
List Lead NotesList the notes on one lead in ServiceTitan, one page per call.
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.
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.
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.
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.
List Location NotesList the notes on one location in ServiceTitan, one page per call.
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.
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.
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.
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.
List Membership Type DiscountsList the discounts granted by one membership type in ServiceTitan. Not paged.
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.
List Membership Type Recurring Service ItemsList the recurring services included in one membership type in ServiceTitan. Not paged.
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.
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.
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.
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.
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.
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.
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.
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.
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.
List Payroll AdjustmentsList payroll adjustments (manually entered earnings or deductions) in ServiceTitan, one page per call. Filter by employee ids or posted date.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
List Project Budget Code Segment ItemsList the items of one budget code segment within a ServiceTitan project, one page per call.
List Project Budget Code SegmentsList the budget code segments of one ServiceTitan project's work breakdown structure.
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.
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.
List Project NotesList the notes on one ServiceTitan project, one page per call.
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.
List Project StatusesList the project statuses configured in ServiceTitan, one page per call. Use the IDs as status_id on a project.
List Project Sub StatusesList the project sub statuses configured in ServiceTitan, one page per call, optionally for one parent status.
List Project TypesList the project types configured in ServiceTitan, one page per call. Use the IDs as project_type_id on a project.
List Proposal TemplatesList proposal templates in ServiceTitan, which map the options of a proposal type to estimate templates.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
List Report CategoriesList the report categories in ServiceTitan. Start here: every other report tool needs a category id.
List ReportsList the reports in one report category in ServiceTitan, with id, name and description.
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.
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.
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.
List Scheduler SessionsList the customer booking sessions of one Scheduling Pro scheduler in ServiceTitan, with customer details, outcome and any job or booking created.
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.
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.
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.
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.
List Tax ZonesList tax zones and their tax rates in ServiceTitan, one page per call; with no filter every active tax zone is returned. Tax zones are read-only through the API.
List TeamsList ServiceTitan dispatch teams, one page per call. Inactive teams are left out unless include_inactive is true.
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.
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.
List TechniciansList technicians in ServiceTitan, the field staff who work jobs, filtered by name or user id. Office employees are a separate resource.
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.
List Technician SkillsList ServiceTitan technician skills, one page per call, optionally for one technician. Each entry is one skill held by one technician.
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.
List Timesheet Activity CategoriesList timesheet activity categories, the groups that activity types belong to, in ServiceTitan, one page per call.
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.
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).
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Remove Appointment ConfirmationRemove the confirmation from a ServiceTitan job appointment, returning it to unconfirmed.
Remove Appointment HoldRemove the hold from a ServiceTitan job appointment that was put on hold.
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.
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.
Remove Job CancellationUndo the cancellation of a ServiceTitan job that was canceled.
Remove Location TagRemove one tag type from one location in ServiceTitan. The tag type itself is kept.
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.
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.
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.
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.
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.
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.
Send Employee Account InviteSend an account invitation to a ServiceTitan employee. The sent invitation cannot be recalled.
Send Employee Password Reset LinkSend a password reset link to a ServiceTitan employee. The sent link cannot be recalled.
Send Technician Account InviteSend an account invitation to a ServiceTitan technician. The sent invitation cannot be recalled.
Send Technician Password Reset LinkSend a password reset link to a ServiceTitan technician. The sent link cannot be recalled.
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.
Set Arrival Window ActiveActivate or deactivate a ServiceTitan arrival window by setting its active flag.
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.
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.
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.
Unassign Technicians from AppointmentRemove one or more technicians from a ServiceTitan job appointment. Returns the appointment.
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.
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.
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.

ServiceTitan

Connect ServiceTitan

What your chats can do